From 8d5d52fc2e635bcbdaeed5dd9eadf8e6c4415555 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 23 Mar 2026 14:19:42 +0100 Subject: [PATCH 01/12] Workflow: only apply enhance.yml values when target field exists (#455) * Initial plan * Workflow: only apply enhance.yml values when target field exists Co-authored-by: Isengo1989 <8600299+Isengo1989@users.noreply.github.com> Agent-Logs-Url: https://github.com/shopware/admin-api-reference/sessions/dd66b63e-00da-40d4-9edf-77e31cc98a95 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Isengo1989 <8600299+Isengo1989@users.noreply.github.com> --- .github/workflows/base_schema.yml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index af81c88..1fba5ee 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -66,13 +66,17 @@ jobs: done for k in $(yq '. | keys | .[]' enhance.yml); do - newData=$(yq ".\"${k}\"" enhance.yml); + newData=$(yq -r ".\"${k}\"" enhance.yml); # escape all keys by default j=$(echo "$k" | sed -r 's/[.]+/"."/g') # remove first extra quote j=${j#*\"} - # add one extra quote at the end - yq -I 4 -o json -i "${j}\" = \"${newData}\"" adminapi.json + # only apply enhancement if the target field exists in adminapi.json + if yq -e "${j}\"" adminapi.json >/dev/null 2>&1; then + yq -I 4 -o json -i "${j}\" = \"${newData}\"" adminapi.json + else + echo "Skip: ${k} (path: ${j}\") not found in adminapi.json" + fi done - name: Download original file From 809bc30d3d8f9c701c2704297b5ad1b7aaf70c60 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 14:21:10 +0100 Subject: [PATCH 02/12] [create-pull-request] automated change (#452) Co-authored-by: shopwareBot --- adminapi.json | 185 ++++++++++++++++++++++++++++-------------- adminapi.summary.json | 2 + 2 files changed, 128 insertions(+), 59 deletions(-) diff --git a/adminapi.json b/adminapi.json index 3f372f6..1ed4538 100644 --- a/adminapi.json +++ b/adminapi.json @@ -75352,6 +75352,27 @@ } } }, + "/_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/container_cache": { "delete": { "tags": [ @@ -77478,6 +77499,45 @@ ] } }, + "/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." + } + } + } + }, "/_info/queue.json": { "get": { "tags": [ @@ -81406,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", @@ -81473,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", @@ -81995,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", @@ -82075,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", @@ -85778,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": { @@ -107757,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" @@ -107841,6 +107935,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -121044,29 +121145,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": { @@ -121087,17 +121180,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": { @@ -121784,48 +121866,31 @@ "properties": { "name": { "type": "string", - "description": "Name of the event" + "description": "Unique name of the businessEventsResponse." }, "class": { "type": "string", - "description": "Class name of the event" + "description": "Class name of business event." }, "data": { "type": "object", - "description": "Available data of event" + "description": "Internal field." }, "aware": { "type": "array", - "description": "Flow builder will base on awareness to show actions", + "description": "Parameter that indicates the areas in which the business event is supported.", "items": { "type": "string" } }, "extensions": { "type": "array", - "description": "Extensions data of event", + "description": "Internal field.", "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." - } } }, "ConsentState": { @@ -121905,9 +121970,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 8e8bf9b..bbc9b45 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -49,6 +49,7 @@ "/_action/theme/{themeId}/configuration", "/_action/theme/{themeId}/reset", "/_action/theme/{themeId}/structured-fields", + "/_action/user/logout", "/_action/validation/email", "/_info/config", "/_info/events.json", @@ -219,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", From 9620141d7d4ccdef192d5fb3bb789bea603b0c4e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 14:22:09 +0100 Subject: [PATCH 03/12] [create-pull-request] automated change (#451) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 181 +++++++++++--------- SwagDigitalSalesRooms-adminapi.summary.json | 3 +- 2 files changed, 100 insertions(+), 84 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 30c25af..d7100d9 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -4884,89 +4884,63 @@ } } }, - "/_action/validation/email": { + "/_action/user/logout": { "post": { "tags": [ - "Email support validation" + "Authorization & Authentication" ], - "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" - } - } - } - }, + "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": "Email is supported" + "description": "Tokens have been revoked successfully." }, - "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." - } - ] - } - } + "401": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } + }, + "/app-system/shop/verify": { + "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" } }, - "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." - } - ] - } - } + { + "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." + } } } }, @@ -9068,10 +9042,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", @@ -9135,6 +9105,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", @@ -9650,10 +9625,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", @@ -9717,6 +9688,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", @@ -13474,7 +13450,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": { @@ -14316,7 +14292,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": { @@ -37349,6 +37325,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" @@ -37463,6 +37471,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index 160ef96..c068d50 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,7 +20,7 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/validation/email", + "/_action/user/logout", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -30,6 +30,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}", From 8f61e92941e8034df49a75819972e16aa056f3af Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 14:22:54 +0100 Subject: [PATCH 04/12] [create-pull-request] automated change (#450) Co-authored-by: shopwareBot Co-authored-by: Micha Hobert --- SwagCommercial-adminapi.json | 1992 ++++++++++++++++++++++++-- SwagCommercial-adminapi.summary.json | 3 +- 2 files changed, 1884 insertions(+), 111 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 66b6cf5..905f06f 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -35791,89 +35791,63 @@ } } }, - "/_action/validation/email": { + "/_action/user/logout": { "post": { "tags": [ - "Email support validation" + "Authorization & Authentication" ], - "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" - } - } - } - }, + "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": "Email is supported" + "description": "Tokens have been revoked successfully." }, - "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." - } - ] - } - } + "401": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } + }, + "/app-system/shop/verify": { + "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" } }, - "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." - } - ] - } - } + { + "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." + } } } }, @@ -37942,6 +37916,37 @@ } }, "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" @@ -38043,6 +38048,12 @@ "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } + }, + "searchActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } } }, "type": "object" @@ -38413,6 +38424,9 @@ "type": "integer", "format": "int64" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -38560,6 +38574,9 @@ "type": "integer", "format": "int64" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41224,10 +41241,18 @@ "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}$" @@ -41236,6 +41261,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41541,10 +41569,18 @@ "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}$" @@ -41553,6 +41589,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41902,8 +41941,7 @@ "id", "identifier", "active", - "appId", - "name" + "appId" ], "properties": { "id": { @@ -41990,8 +42028,7 @@ "id", "identifier", "active", - "appId", - "name" + "appId" ], "properties": { "id": { @@ -42181,6 +42218,35 @@ }, "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": { @@ -42418,6 +42484,9 @@ "createdBy": { "$ref": "#/components/schemas/User" }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, "organizations": { "type": "array", "items": { @@ -43894,6 +43963,99 @@ } }, "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" @@ -44258,6 +44420,99 @@ } }, "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" @@ -45926,6 +46181,37 @@ } }, "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" @@ -46133,6 +46419,37 @@ } }, "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" @@ -46957,6 +47274,37 @@ }, "type": "object" }, + "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" + }, "organization": { "properties": { "links": { @@ -47017,6 +47365,37 @@ }, "type": "object" }, + "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" + }, "b2bPendingOrders": { "properties": { "links": { @@ -47109,6 +47488,37 @@ } }, "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" @@ -47302,6 +47712,37 @@ }, "type": "object" }, + "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" + }, "organization": { "properties": { "links": { @@ -47362,6 +47803,37 @@ }, "type": "object" }, + "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" + }, "b2bPendingOrders": { "properties": { "links": { @@ -47454,6 +47926,37 @@ } }, "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" @@ -47815,10 +48318,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", @@ -47882,6 +48381,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", @@ -48467,10 +48971,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", @@ -48534,6 +49034,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", @@ -51227,6 +51732,37 @@ } }, "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" @@ -51660,6 +52196,37 @@ } }, "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" @@ -52137,6 +52704,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "advancedSearchConfigFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "customFieldSet": { @@ -52263,6 +52866,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "advancedSearchConfigFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" }, @@ -52945,7 +53584,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": { @@ -53464,6 +54103,99 @@ } }, "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" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "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": { + "related": { + "type": "string", + "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" } }, "type": "object" @@ -54186,7 +54918,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": { @@ -54705,6 +55437,99 @@ } }, "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" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "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": { + "related": { + "type": "string", + "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" } }, "type": "object" @@ -55423,6 +56248,35 @@ } }, "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" @@ -55612,6 +56466,35 @@ } }, "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" @@ -59756,6 +60639,37 @@ }, "type": "object" }, + "advancedSearchSynonyms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_synonym" + }, + "id": { + "type": "string", + "example": "a139d0125b356216337e8386fca65e22" + } + } + } + } + }, + "type": "object" + }, "b2bPendingOrders": { "properties": { "links": { @@ -60433,6 +61347,37 @@ }, "type": "object" }, + "advancedSearchSynonyms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_synonym" + }, + "id": { + "type": "string", + "example": "a139d0125b356216337e8386fca65e22" + } + } + } + } + }, + "type": "object" + }, "b2bPendingOrders": { "properties": { "links": { @@ -70289,7 +71234,7 @@ }, "type": "object" }, - "warehouses": { + "warehouse": { "properties": { "links": { "type": "object", @@ -70297,23 +71242,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouses" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "372d30dd2849813ef674855253900679" } } } @@ -70384,11 +71327,8 @@ "product": { "$ref": "#/components/schemas/Product" }, - "warehouses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Warehouse" - } + "warehouse": { + "$ref": "#/components/schemas/Warehouse" } }, "type": "object" @@ -71304,8 +72244,7 @@ { "required": [ "id", - "reasonKey", - "content" + "reasonKey" ], "properties": { "id": { @@ -71375,8 +72314,7 @@ "OrderReturnLineItemReason": { "required": [ "id", - "reasonKey", - "content" + "reasonKey" ], "properties": { "id": { @@ -74611,6 +75549,37 @@ } }, "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" @@ -76190,6 +77159,37 @@ } }, "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" @@ -79789,6 +80789,68 @@ } }, "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" @@ -79918,6 +80980,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" @@ -80003,6 +81097,68 @@ } }, "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" @@ -80030,6 +81186,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -87699,6 +88862,99 @@ }, "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": { @@ -89222,6 +90478,99 @@ }, "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": { @@ -93132,6 +94481,9 @@ "name": { "type": "string" }, + "type": { + "type": "string" + }, "position": { "type": "object" }, @@ -93252,6 +94604,9 @@ "name": { "type": "string" }, + "type": { + "type": "string" + }, "position": { "type": "object" }, @@ -97534,6 +98889,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -97798,6 +99157,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -99114,6 +100477,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" @@ -99463,6 +100857,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" @@ -101180,6 +102605,161 @@ } }, "type": "object" + }, + "createdAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "e0d6784016e56c0ac2ed620abadda119" + } + } + } + } + }, + "type": "object" + }, + "updatedAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "a26e117c9f4ed119b46afbc3e3cae7f0" + } + } + } + } + }, + "type": "object" + }, + "createdBudgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdBudgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "62528618b0cda8a734a729c2dd9407a2" + } + } + } + } + }, + "type": "object" + }, + "createdIndividualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdIndividualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "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" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -101946,6 +103526,161 @@ } }, "type": "object" + }, + "createdAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "e0d6784016e56c0ac2ed620abadda119" + } + } + } + } + }, + "type": "object" + }, + "updatedAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "a26e117c9f4ed119b46afbc3e3cae7f0" + } + } + } + } + }, + "type": "object" + }, + "createdBudgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdBudgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "62528618b0cda8a734a729c2dd9407a2" + } + } + } + } + }, + "type": "object" + }, + "createdIndividualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdIndividualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "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" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -102702,6 +104437,37 @@ } }, "type": "object" + }, + "orderWarehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/orderWarehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "a578b672a12a5598c96babdfd01f0de2" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -102759,6 +104525,12 @@ "items": { "$ref": "#/components/schemas/Product" } + }, + "orderWarehouseGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } } }, "type": "object" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index d67a1bc..ec53ba9 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -11,7 +11,7 @@ "/_action/share-config/upload/{entity}", "/_action/text-to-image/generate", "/_action/update-employee", - "/_action/validation/email", + "/_action/user/logout", "/_proxy-quote/{salesChannelId}", "/advanced-search-action", "/advanced-search-action-search-term", @@ -97,6 +97,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", From 937b3f3e712d5af1293cc37d2146bf2f7d269206 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 14:23:16 +0100 Subject: [PATCH 05/12] [create-pull-request] automated change (#449) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 181 ++++++++++--------- SwagCustomizedProducts-adminapi.summary.json | 3 +- 2 files changed, 100 insertions(+), 84 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 25bc63f..7945369 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -5425,89 +5425,63 @@ } } }, - "/_action/validation/email": { + "/_action/user/logout": { "post": { "tags": [ - "Email support validation" + "Authorization & Authentication" ], - "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" - } - } - } - }, + "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": "Email is supported" + "description": "Tokens have been revoked successfully." }, - "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." - } - ] - } - } + "401": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } + }, + "/app-system/shop/verify": { + "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" } }, - "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." - } - ] - } - } + { + "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." + } } } } @@ -8552,10 +8526,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", @@ -8619,6 +8589,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", @@ -9134,10 +9109,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", @@ -9201,6 +9172,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", @@ -12822,7 +12798,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": { @@ -13628,7 +13604,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": { @@ -34334,6 +34310,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" @@ -34412,6 +34420,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index bbeb208..ded1fb2 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,6 +1,6 @@ { "paths": [ - "/_action/validation/email", + "/_action/user/logout", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -11,6 +11,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", From 7c6bc9b231e01870ae4ce040f122efabddb4cb55 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Apr 2026 16:47:22 +0200 Subject: [PATCH 06/12] [create-pull-request] automated change (#471) Co-authored-by: shopwareBot --- adminapi.json | 10676 +++++++++++++++++++++++----------------- adminapi.summary.json | 12 + 2 files changed, 6252 insertions(+), 4436 deletions(-) diff --git a/adminapi.json b/adminapi.json index 1ed4538..8596036 100644 --- a/adminapi.json +++ b/adminapi.json @@ -58984,14 +58984,15 @@ } } }, - "/sales-channel-type": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "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 Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { "name": "limit", @@ -59020,7 +59021,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Sales Channel Tracking Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -59039,7 +59040,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } ] @@ -59053,16 +59054,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/sales-channel-tracking-customer?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/sales-channel-tracking-customer?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/sales-channel-tracking-customer?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/sales-channel-tracking-customer?limit=25&page=2" } } } @@ -59083,7 +59084,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59098,11 +59099,12 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Create a new Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { "name": "_response", @@ -59121,14 +59123,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -59140,7 +59142,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59155,7 +59157,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59171,14 +59173,15 @@ } } }, - "/search/sales-channel-type": { + "/search/sales-channel-tracking-customer": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Search for the Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelType", + "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -59206,7 +59209,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -59220,7 +59223,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59238,7 +59241,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59255,19 +59258,20 @@ } } }, - "/sales-channel-type/{id}": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "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 Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -59277,7 +59281,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -59289,7 +59293,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59304,7 +59308,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59321,16 +59325,17 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Delete a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -59361,16 +59366,17 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "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 Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -59388,18 +59394,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Sales Channel Tracking Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -59411,7 +59417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59426,7 +59432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59445,14 +59451,15 @@ } } }, - "/aggregate/sales-channel-type": { + "/aggregate/sales-channel-tracking-customer": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Aggregate for the Sales Channel Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", + "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingCustomer", "requestBody": { "required": true, "content": { @@ -59476,7 +59483,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -59490,7 +59497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59508,7 +59515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -59525,14 +59532,15 @@ } } }, - "/salutation": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "List with basic information of Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ { "name": "limit", @@ -59561,7 +59569,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Sales Channel Tracking Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -59580,7 +59588,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } ] @@ -59594,16 +59602,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/sales-channel-tracking-order?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/sales-channel-tracking-order?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/sales-channel-tracking-order?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/sales-channel-tracking-order?limit=25&page=2" } } } @@ -59624,7 +59632,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59639,11 +59647,12 @@ }, "post": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Fetches salutations with a criteria obj.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { "name": "_response", @@ -59662,14 +59671,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -59681,7 +59690,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59696,7 +59705,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59712,14 +59721,15 @@ } } }, - "/search/salutation": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Search for the Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalutation", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { "name": "sw-include-search-info", @@ -59747,7 +59757,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -59761,7 +59771,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59779,7 +59789,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59796,19 +59806,20 @@ } } }, - "/salutation/{id}": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Detailed information about a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -59818,7 +59829,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -59830,7 +59841,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59845,7 +59856,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59862,16 +59873,17 @@ }, "delete": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Delete a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -59902,16 +59914,17 @@ }, "patch": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Partially update information about a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -59929,18 +59942,18 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Sales Channel Tracking Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -59952,7 +59965,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59967,7 +59980,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -59986,14 +59999,15 @@ } } }, - "/aggregate/salutation": { + "/aggregate/sales-channel-tracking-order": { "post": { "tags": [ - "Salutation" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Aggregate for the Salutation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", + "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { @@ -60017,7 +60031,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -60031,7 +60045,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -60049,7 +60063,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -60066,14 +60080,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", @@ -60102,7 +60116,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60121,7 +60135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -60135,16 +60149,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" } } } @@ -60165,7 +60179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60180,11 +60194,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", @@ -60203,14 +60217,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": { @@ -60222,7 +60236,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60237,7 +60251,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60253,14 +60267,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", "parameters": [ { "name": "sw-include-search-info", @@ -60288,7 +60302,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -60302,7 +60316,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60320,7 +60334,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60337,19 +60351,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", @@ -60359,7 +60373,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -60371,7 +60385,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60386,7 +60400,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60403,16 +60417,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", @@ -60443,16 +60457,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", @@ -60470,18 +60484,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": { @@ -60493,7 +60507,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60508,7 +60522,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60527,14 +60541,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": { @@ -60558,7 +60572,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -60572,7 +60586,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60590,7 +60604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -60607,14 +60621,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", @@ -60643,7 +60657,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60662,7 +60676,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } ] @@ -60676,16 +60690,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" } } } @@ -60706,7 +60720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60721,11 +60735,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", @@ -60744,14 +60758,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": { @@ -60763,7 +60777,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60778,7 +60792,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60794,14 +60808,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", "parameters": [ { "name": "sw-include-search-info", @@ -60829,7 +60843,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -60843,7 +60857,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60861,7 +60875,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60878,19 +60892,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", @@ -60900,7 +60914,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -60912,7 +60926,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60927,7 +60941,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -60944,16 +60958,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", @@ -60984,16 +60998,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", @@ -61011,18 +61025,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": { @@ -61034,7 +61048,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -61049,7 +61063,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -61068,14 +61082,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": { @@ -61099,7 +61113,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -61113,7 +61127,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -61131,7 +61145,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -61148,14 +61162,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", @@ -61184,7 +61198,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61203,7 +61217,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -61217,16 +61231,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" } } } @@ -61247,7 +61261,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61262,11 +61276,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", @@ -61285,14 +61299,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": { @@ -61304,7 +61318,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61319,7 +61333,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61335,14 +61349,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", "parameters": [ { "name": "sw-include-search-info", @@ -61370,7 +61384,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -61384,7 +61398,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61402,7 +61416,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61419,19 +61433,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", @@ -61441,7 +61455,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -61453,7 +61467,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61468,7 +61482,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61485,16 +61499,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", @@ -61525,16 +61539,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", @@ -61552,18 +61566,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": { @@ -61575,7 +61589,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61590,7 +61604,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61609,14 +61623,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": { @@ -61640,7 +61654,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -61654,7 +61668,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61672,7 +61686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -61689,14 +61703,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", @@ -61725,7 +61739,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61744,7 +61758,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } ] @@ -61758,16 +61772,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" } } } @@ -61788,7 +61802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -61803,11 +61817,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", @@ -61826,14 +61840,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": { @@ -61845,7 +61859,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -61860,7 +61874,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -61876,14 +61890,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", "parameters": [ { "name": "sw-include-search-info", @@ -61911,7 +61925,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -61925,7 +61939,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -61943,7 +61957,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -61960,19 +61974,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", @@ -61982,7 +61996,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -61994,7 +62008,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62009,7 +62023,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62026,16 +62040,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", @@ -62066,16 +62080,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", @@ -62093,18 +62107,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": { @@ -62116,7 +62130,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62131,7 +62145,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62150,14 +62164,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": { @@ -62181,7 +62195,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -62195,7 +62209,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62213,7 +62227,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -62230,14 +62244,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", @@ -62266,7 +62280,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62285,7 +62299,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -62299,16 +62313,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" } } } @@ -62329,7 +62343,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62344,11 +62358,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", @@ -62367,14 +62381,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": { @@ -62386,7 +62400,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62401,7 +62415,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62417,14 +62431,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", "parameters": [ { "name": "sw-include-search-info", @@ -62452,7 +62466,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -62466,7 +62480,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62484,7 +62498,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62501,19 +62515,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", @@ -62523,7 +62537,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -62535,7 +62549,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62550,7 +62564,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62567,16 +62581,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", @@ -62607,16 +62621,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", @@ -62634,18 +62648,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": { @@ -62657,7 +62671,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62672,7 +62686,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62691,14 +62705,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": { @@ -62722,7 +62736,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -62736,7 +62750,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62754,7 +62768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -62771,14 +62785,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", @@ -62807,7 +62821,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62826,7 +62840,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -62840,16 +62854,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" } } } @@ -62870,7 +62884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62885,11 +62899,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", @@ -62908,14 +62922,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": { @@ -62927,7 +62941,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62942,7 +62956,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62958,14 +62972,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", "parameters": [ { "name": "sw-include-search-info", @@ -62993,7 +63007,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -63007,7 +63021,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63025,7 +63039,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63042,19 +63056,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", @@ -63064,7 +63078,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -63076,7 +63090,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63091,7 +63105,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63108,16 +63122,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", @@ -63148,16 +63162,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", @@ -63175,18 +63189,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": { @@ -63198,7 +63212,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63213,7 +63227,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63232,14 +63246,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": { @@ -63263,7 +63277,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -63277,7 +63291,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63295,7 +63309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -63312,14 +63326,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", @@ -63348,7 +63362,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63367,7 +63381,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -63381,16 +63395,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" } } } @@ -63411,7 +63425,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63426,11 +63440,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", @@ -63449,14 +63463,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": { @@ -63468,7 +63482,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63483,7 +63497,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63499,14 +63513,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", "parameters": [ { "name": "sw-include-search-info", @@ -63534,7 +63548,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -63548,7 +63562,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63566,7 +63580,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63583,19 +63597,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", @@ -63605,7 +63619,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -63617,7 +63631,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63632,7 +63646,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63649,16 +63663,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", @@ -63689,16 +63703,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", @@ -63716,18 +63730,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": { @@ -63739,7 +63753,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63754,7 +63768,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63773,14 +63787,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": { @@ -63804,7 +63818,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -63818,7 +63832,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63836,7 +63850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -63853,14 +63867,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", @@ -63889,7 +63903,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63908,7 +63922,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -63922,16 +63936,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" } } } @@ -63952,7 +63966,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63967,11 +63981,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", @@ -63990,14 +64004,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": { @@ -64009,7 +64023,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64024,7 +64038,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64040,14 +64054,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", "parameters": [ { "name": "sw-include-search-info", @@ -64075,7 +64089,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -64089,7 +64103,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64107,7 +64121,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64124,19 +64138,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", @@ -64146,7 +64160,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -64158,7 +64172,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64173,7 +64187,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64190,16 +64204,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", @@ -64230,16 +64244,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", @@ -64257,18 +64271,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": { @@ -64280,7 +64294,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64295,7 +64309,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64314,14 +64328,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": { @@ -64345,7 +64359,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -64359,7 +64373,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64377,7 +64391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -64394,14 +64408,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", @@ -64430,7 +64444,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64449,7 +64463,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } ] @@ -64463,16 +64477,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" } } } @@ -64493,7 +64507,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64508,11 +64522,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", @@ -64531,14 +64545,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": { @@ -64550,7 +64564,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64565,7 +64579,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64581,14 +64595,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", "parameters": [ { "name": "sw-include-search-info", @@ -64616,7 +64630,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -64630,7 +64644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64648,7 +64662,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64665,19 +64679,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", @@ -64687,7 +64701,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -64699,7 +64713,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64714,7 +64728,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64731,16 +64745,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", @@ -64771,16 +64785,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", @@ -64798,18 +64812,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": { @@ -64821,7 +64835,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64836,7 +64850,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64855,14 +64869,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": { @@ -64886,7 +64900,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -64900,7 +64914,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64918,7 +64932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -64935,14 +64949,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", @@ -64971,7 +64985,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64990,7 +65004,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -65004,16 +65018,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" } } } @@ -65034,7 +65048,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65049,11 +65063,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", @@ -65072,14 +65086,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": { @@ -65091,7 +65105,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65106,7 +65120,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65122,14 +65136,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", "parameters": [ { "name": "sw-include-search-info", @@ -65157,7 +65171,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -65171,7 +65185,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65189,7 +65203,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65206,19 +65220,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", @@ -65228,7 +65242,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -65240,7 +65254,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65255,7 +65269,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65272,16 +65286,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", @@ -65312,16 +65326,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", @@ -65339,18 +65353,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": { @@ -65362,7 +65376,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65377,7 +65391,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65396,14 +65410,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": { @@ -65427,7 +65441,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -65441,7 +65455,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65459,7 +65473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -65476,14 +65490,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", @@ -65512,7 +65526,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65531,7 +65545,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -65545,16 +65559,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" } } } @@ -65575,7 +65589,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65590,11 +65604,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", @@ -65613,14 +65627,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": { @@ -65632,7 +65646,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65647,7 +65661,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65663,14 +65677,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", "parameters": [ { "name": "sw-include-search-info", @@ -65698,7 +65712,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -65712,7 +65726,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65730,7 +65744,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65747,19 +65761,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", @@ -65769,7 +65783,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -65781,7 +65795,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65796,7 +65810,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65813,16 +65827,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", @@ -65853,16 +65867,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", @@ -65880,18 +65894,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": { @@ -65903,7 +65917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65918,7 +65932,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -65937,14 +65951,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": { @@ -65968,7 +65982,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -65982,7 +65996,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -66000,7 +66014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -66017,14 +66031,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", @@ -66053,7 +66067,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66072,7 +66086,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -66086,16 +66100,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" } } } @@ -66116,7 +66130,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66131,11 +66145,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", @@ -66154,14 +66168,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": { @@ -66173,7 +66187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66188,7 +66202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66204,14 +66218,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", "parameters": [ { "name": "sw-include-search-info", @@ -66239,7 +66253,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -66253,7 +66267,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66271,7 +66285,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66288,19 +66302,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", @@ -66310,7 +66324,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -66322,7 +66336,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66337,7 +66351,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66354,16 +66368,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", @@ -66394,16 +66408,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", @@ -66421,18 +66435,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": { @@ -66444,7 +66458,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66459,7 +66473,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66478,14 +66492,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": { @@ -66509,7 +66523,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -66523,7 +66537,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66541,7 +66555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -66558,14 +66572,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", @@ -66594,7 +66608,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66613,7 +66627,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -66627,16 +66641,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" } } } @@ -66657,7 +66671,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66672,11 +66686,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", @@ -66695,14 +66709,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": { @@ -66714,7 +66728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66729,7 +66743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66745,14 +66759,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", "parameters": [ { "name": "sw-include-search-info", @@ -66780,7 +66794,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -66794,7 +66808,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66812,7 +66826,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66829,19 +66843,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", @@ -66851,7 +66865,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -66863,7 +66877,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66878,7 +66892,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66895,16 +66909,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", @@ -66935,16 +66949,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", @@ -66962,18 +66976,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": { @@ -66985,7 +66999,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -67000,7 +67014,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -67019,14 +67033,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": { @@ -67050,7 +67064,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -67064,7 +67078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -67082,7 +67096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -67099,14 +67113,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", @@ -67135,7 +67149,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67154,7 +67168,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -67168,16 +67182,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" } } } @@ -67198,7 +67212,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67213,11 +67227,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", @@ -67236,14 +67250,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": { @@ -67255,7 +67269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67270,7 +67284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67286,14 +67300,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", "parameters": [ { "name": "sw-include-search-info", @@ -67321,7 +67335,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -67335,7 +67349,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67353,7 +67367,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67370,19 +67384,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", @@ -67392,7 +67406,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -67404,7 +67418,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67419,7 +67433,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67436,16 +67450,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", @@ -67476,16 +67490,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", @@ -67503,18 +67517,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": { @@ -67526,7 +67540,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67541,7 +67555,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67560,14 +67574,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": { @@ -67591,7 +67605,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -67605,7 +67619,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67623,7 +67637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -67640,14 +67654,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", @@ -67676,7 +67690,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67695,7 +67709,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -67709,16 +67723,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" } } } @@ -67739,7 +67753,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67754,11 +67768,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", @@ -67777,14 +67791,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": { @@ -67796,7 +67810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67811,7 +67825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67827,14 +67841,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", "parameters": [ { "name": "sw-include-search-info", @@ -67862,7 +67876,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -67876,7 +67890,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67894,7 +67908,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67911,19 +67925,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", @@ -67933,7 +67947,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -67945,7 +67959,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67960,7 +67974,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67977,16 +67991,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", @@ -68017,16 +68031,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", @@ -68044,18 +68058,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": { @@ -68067,7 +68081,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -68082,7 +68096,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -68101,14 +68115,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": { @@ -68132,7 +68146,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -68146,7 +68160,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -68164,7 +68178,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -68181,14 +68195,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", @@ -68217,7 +68231,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68236,7 +68250,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } ] @@ -68250,16 +68264,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" } } } @@ -68280,7 +68294,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68295,11 +68309,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", @@ -68318,14 +68332,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": { @@ -68337,7 +68351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68352,7 +68366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68368,14 +68382,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", "parameters": [ { "name": "sw-include-search-info", @@ -68403,7 +68417,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -68417,7 +68431,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68435,7 +68449,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68452,19 +68466,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", @@ -68474,7 +68488,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -68486,7 +68500,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68501,7 +68515,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68518,16 +68532,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", @@ -68558,16 +68572,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", @@ -68585,18 +68599,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": { @@ -68608,7 +68622,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68623,7 +68637,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68642,14 +68656,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": { @@ -68673,7 +68687,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -68687,7 +68701,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68705,7 +68719,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -68722,14 +68736,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", @@ -68758,7 +68772,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68777,7 +68791,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } ] @@ -68791,16 +68805,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" } } } @@ -68821,7 +68835,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -68836,11 +68850,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", @@ -68859,14 +68873,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": { @@ -68878,7 +68892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -68893,7 +68907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -68909,14 +68923,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", "parameters": [ { "name": "sw-include-search-info", @@ -68944,7 +68958,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -68958,7 +68972,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -68976,7 +68990,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -68993,19 +69007,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", @@ -69015,7 +69029,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -69027,7 +69041,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69042,7 +69056,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69059,16 +69073,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", @@ -69099,16 +69113,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", @@ -69126,18 +69140,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": { @@ -69149,7 +69163,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69164,7 +69178,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69183,14 +69197,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": { @@ -69214,7 +69228,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -69228,7 +69242,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69246,7 +69260,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -69263,14 +69277,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", @@ -69299,7 +69313,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69318,7 +69332,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -69332,16 +69346,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" } } } @@ -69362,7 +69376,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69377,11 +69391,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", @@ -69400,14 +69414,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": { @@ -69419,7 +69433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69434,7 +69448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69450,14 +69464,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", "parameters": [ { "name": "sw-include-search-info", @@ -69485,7 +69499,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -69499,7 +69513,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69517,7 +69531,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69534,19 +69548,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", @@ -69556,7 +69570,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -69568,7 +69582,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69583,7 +69597,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69600,16 +69614,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", @@ -69640,16 +69654,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", @@ -69667,18 +69681,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": { @@ -69690,7 +69704,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69705,7 +69719,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69724,14 +69738,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": { @@ -69755,7 +69769,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -69769,7 +69783,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69787,7 +69801,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -69804,14 +69818,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", @@ -69840,7 +69854,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69859,7 +69873,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -69873,16 +69887,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" } } } @@ -69903,7 +69917,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69918,11 +69932,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", @@ -69941,14 +69955,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": { @@ -69960,7 +69974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69975,7 +69989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69991,14 +70005,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", "parameters": [ { "name": "sw-include-search-info", @@ -70026,7 +70040,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -70040,7 +70054,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70058,7 +70072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70075,19 +70089,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", @@ -70097,7 +70111,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -70109,7 +70123,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70124,7 +70138,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70141,16 +70155,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", @@ -70181,16 +70195,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", @@ -70208,18 +70222,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": { @@ -70231,7 +70245,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70246,7 +70260,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70265,14 +70279,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": { @@ -70296,7 +70310,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -70310,7 +70324,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70328,7 +70342,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -70345,14 +70359,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", @@ -70381,7 +70395,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70400,7 +70414,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -70414,16 +70428,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" } } } @@ -70444,7 +70458,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70459,11 +70473,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", @@ -70482,14 +70496,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": { @@ -70501,7 +70515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70516,7 +70530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70532,14 +70546,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", "parameters": [ { "name": "sw-include-search-info", @@ -70567,7 +70581,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -70581,7 +70595,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70599,7 +70613,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70616,19 +70630,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", @@ -70638,7 +70652,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -70650,7 +70664,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70665,7 +70679,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70682,16 +70696,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", @@ -70722,16 +70736,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", @@ -70749,18 +70763,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": { @@ -70772,7 +70786,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70787,7 +70801,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70806,14 +70820,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": { @@ -70837,7 +70851,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -70851,7 +70865,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70869,7 +70883,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -70886,14 +70900,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", @@ -70922,7 +70936,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70941,7 +70955,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } ] @@ -70955,16 +70969,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" } } } @@ -70985,7 +70999,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71000,11 +71014,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", @@ -71023,14 +71037,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": { @@ -71042,7 +71056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71057,7 +71071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71073,14 +71087,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", "parameters": [ { "name": "sw-include-search-info", @@ -71108,7 +71122,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -71122,7 +71136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71140,7 +71154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71157,19 +71171,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", @@ -71179,7 +71193,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -71191,7 +71205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71206,7 +71220,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71223,16 +71237,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", @@ -71263,16 +71277,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", @@ -71290,18 +71304,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": { @@ -71313,7 +71327,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71328,7 +71342,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71347,14 +71361,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": { @@ -71378,7 +71392,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -71392,7 +71406,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71410,7 +71424,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -71427,14 +71441,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", @@ -71463,7 +71477,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -71482,7 +71496,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } ] @@ -71496,16 +71510,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" } } } @@ -71526,7 +71540,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71541,11 +71555,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", @@ -71564,14 +71578,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": { @@ -71583,7 +71597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71598,7 +71612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71614,14 +71628,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", "parameters": [ { "name": "sw-include-search-info", @@ -71649,7 +71663,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -71663,7 +71677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71681,7 +71695,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71698,19 +71712,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", @@ -71720,7 +71734,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -71732,7 +71746,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71747,7 +71761,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71764,16 +71778,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", @@ -71804,16 +71818,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", @@ -71831,18 +71845,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": { @@ -71854,7 +71868,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71869,7 +71883,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71888,14 +71902,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": { @@ -71919,7 +71933,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -71933,7 +71947,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71951,7 +71965,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -71968,14 +71982,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", @@ -72004,7 +72018,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72023,7 +72037,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } ] @@ -72037,16 +72051,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" } } } @@ -72067,7 +72081,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72082,11 +72096,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", @@ -72105,14 +72119,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": { @@ -72124,7 +72138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72139,7 +72153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72155,14 +72169,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", "parameters": [ { "name": "sw-include-search-info", @@ -72190,7 +72204,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -72204,7 +72218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72222,7 +72236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72239,19 +72253,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", @@ -72261,7 +72275,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -72273,7 +72287,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72288,7 +72302,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72305,16 +72319,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", @@ -72345,16 +72359,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", @@ -72372,18 +72386,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": { @@ -72395,7 +72409,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72410,7 +72424,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72429,14 +72443,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": { @@ -72460,7 +72474,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -72474,7 +72488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72492,7 +72506,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -72509,14 +72523,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", @@ -72545,7 +72559,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72564,7 +72578,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -72578,16 +72592,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" } } } @@ -72608,7 +72622,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72623,11 +72637,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", @@ -72646,14 +72660,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": { @@ -72665,7 +72679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72680,7 +72694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72696,14 +72710,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", "parameters": [ { "name": "sw-include-search-info", @@ -72731,7 +72745,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -72745,7 +72759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72763,7 +72777,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72780,19 +72794,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", @@ -72802,7 +72816,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -72814,7 +72828,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72829,7 +72843,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72846,16 +72860,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", @@ -72886,16 +72900,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", @@ -72913,18 +72927,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": { @@ -72936,7 +72950,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72951,7 +72965,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -72970,14 +72984,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": { @@ -73001,7 +73015,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -73015,7 +73029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -73033,7 +73047,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -73050,14 +73064,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", @@ -73086,7 +73100,7 @@ ], "responses": { "200": { - "description": "List of Webhook resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73105,7 +73119,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -73119,16 +73133,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" } } } @@ -73149,7 +73163,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73164,11 +73178,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", @@ -73187,14 +73201,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": { @@ -73206,7 +73220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73221,7 +73235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73237,14 +73251,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", "parameters": [ { "name": "sw-include-search-info", @@ -73272,7 +73286,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -73286,7 +73300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73304,7 +73318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73321,19 +73335,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", @@ -73343,7 +73357,7 @@ ], "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -73355,7 +73369,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73370,7 +73384,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73387,16 +73401,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", @@ -73427,16 +73441,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", @@ -73454,18 +73468,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": { @@ -73477,7 +73491,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73492,7 +73506,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73511,14 +73525,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": { @@ -73542,7 +73556,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -73556,7 +73570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73574,7 +73588,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -73591,14 +73605,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", @@ -73627,7 +73641,7 @@ ], "responses": { "200": { - "description": "List of Webhook Event Log resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73646,7 +73660,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -73660,16 +73674,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" } } } @@ -73690,7 +73704,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73705,11 +73719,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", @@ -73728,14 +73742,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": { @@ -73747,7 +73761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73762,7 +73776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73778,14 +73792,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", "parameters": [ { "name": "sw-include-search-info", @@ -73813,7 +73827,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -73827,7 +73841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73845,7 +73859,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73862,19 +73876,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", @@ -73884,7 +73898,7 @@ ], "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -73896,7 +73910,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73911,7 +73925,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73928,16 +73942,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", @@ -73968,16 +73982,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", @@ -73995,18 +74009,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": { @@ -74018,7 +74032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -74033,7 +74047,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -74052,14 +74066,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": { @@ -74083,7 +74097,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -74097,7 +74111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -74115,7 +74129,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -74132,1029 +74146,1976 @@ } } }, - "/_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/order_delivery/{orderDeliveryId}/state/{transition}": { - "post": { + "/webhook": { + "get": { "tags": [ - "Order Management" + "Webhook" ], - "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": "List with basic information of Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhookList", "parameters": [ { - "name": "orderDeliveryId", - "in": "path", - "description": "Identifier of the order delivery.", - "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": "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, + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", "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}$" + "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" + } + } + } + ] + } + } } - }, - "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", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } } - }, - "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" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/oauth/token": { + }, "post": { "tags": [ - "Authorization & Authentication" + "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": "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" - } - ] + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Authorized successfully.", + "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": [ - "token_type", - "expires_in", - "access_token" + "data" ], "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" + "data": { + "$ref": "#/components/schemas/Webhook" } - }, - "type": "object" + } } } } }, "400": { "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/oauth/sso/config": { - "get": { + "/search/webhook": { + "post": { "tags": [ - "Experimental", - "SSO Login configuration" + "Webhook" ], - "summary": "Experimental: Loads SSO login configuration.", - "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", + "summary": "Search for the Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchWebhook", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { - "description": "Experimental: Returns the configuration for the SSO login page forward.", + "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": { - "useDefault": { - "description": "Experimental: Indicates which login is used. Default or SSO.", - "type": "boolean" + "total": { + "type": "integer" }, - "url": { - "description": "Experimental: Contains the return url for the Shopware SSO login.", - "type": "string" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "operationId": "loadSsoLoginConfig" + } } }, - "/oauth/sso/code": { + "/webhook/{id}": { "get": { "tags": [ - "Experimental", - "SSO Login callback" + "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}$" + } + } ], - "summary": "Experimental: Callback for SSO login", - "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", "responses": { "200": { - "description": "Authorisation process continues", + "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" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + } + } } } } }, - "302": { - "description": "Experimental: Forwards to the Shopware admin" + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "operationId": "callBackWithCode" - } - }, - "/oauth/sso/auth": { - "get": { + } + }, + "delete": { "tags": [ - "Experimental", - "SSO Login forward" + "Webhook" ], - "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" + "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" + } } - } - } - }, - "/_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" + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/sso/invite-user": { - "post": { + }, + "patch": { "tags": [ - "Experimental", - "Invite a new SSO user" + "Webhook" ], - "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": "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" + } } - } - } - }, - "/_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": { + "description": "Partially update information about a Webhook resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Webhook" + } + } + } + }, "responses": { "200": { - "description": "Statistics received", + "description": "Detail of Webhook", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "object", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "stats": { - "type": [ - "object", - "null" - ], + { + "type": "object", "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" - } - } - } + "data": { + "$ref": "#/components/schemas/Webhook" } } } - } + ] } - } - } - } - } - } - }, - "/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 + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" } } } } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { - "description": "Unauthorized - User not logged in or invalid session" + "$ref": "#/components/responses/401" } } } }, - "/consents/accept": { + "/aggregate/webhook": { "post": { "tags": [ - "Consent Management", - "Experimental" + "Webhook" ], - "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": "Aggregate for the Webhook resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhook", "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } } }, "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", + "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": { - "$ref": "#/components/schemas/ConsentState" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } + } + } } } } }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" + "400": { + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized - User not logged in or invalid session" + "$ref": "#/components/responses/401" } } } }, - "/consents/revoke": { - "post": { + "/webhook-event-log": { + "get": { "tags": [ - "Consent Management", - "Experimental" + "Webhook Event Log" ], - "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" - } - }, - "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" - } - } + "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" } }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "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": "Information about the cache state.", + "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": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" + "total": { + "type": "integer" }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "type": "object" + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/order/document/download": { + }, "post": { "tags": [ - "Document Management" + "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" + ] + } + } ], - "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/WebhookEventLog" } } } }, "responses": { "200": { - "description": "The documents.", + "description": "Detail of WebhookEventLog", "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/WebhookEventLog" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/order/document/{documentTypeName}/create": { + "/search/webhook-event-log": { "post": { "tags": [ - "Document Management" + "Webhook Event Log" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Search for the Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchWebhookEventLog", "parameters": [ { - "name": "documentTypeName", - "in": "path", - "description": "The type of document to create", - "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" + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" } } ], "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" - } - } - } + "$ref": "#/components/schemas/Criteria" } } } }, "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": { - "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", - "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" - } - } - ], - "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}$" + "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" + } + } + } } - }, - "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", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "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" + } } } - } - }, - "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_info/routes": { + "/webhook-event-log/{id}": { "get": { - "summary": "Get API routes", - "operationId": "getRoutes", "tags": [ - "System Info & Health Check" + "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": "Successful operation", + "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": [ - "endpoints" + "data" ], "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } + "data": { + "$ref": "#/components/schemas/WebhookEventLog" } } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_info/health-check": { - "get": { + }, + "delete": { "tags": [ - "System Info & Health Check" + "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" + } + } ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", "responses": { - "200": { - "description": "Returns empty response" + "204": { + "$ref": "#/components/responses/204" }, - "500": { - "description": "Application is not working properly" + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_info/system-health-check": { - "get": { + }, + "patch": { "tags": [ - "System Info & Health Check" + "Webhook Event Log" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Partially update information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateWebhookEventLog", "parameters": [ { - "name": "verbose", + "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", - "required": false, + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" + "type": "string" + } } ], + "requestBody": { + "description": "Partially update information about a Webhook Event Log resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + }, "responses": { "200": { - "description": "Returns the system health check results", + "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": { - "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/WebhookEventLog" } } } } } }, - "500": { - "description": "Application is not working properly" + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/mail-template/send": { + "/aggregate/webhook-event-log": { "post": { "tags": [ - "Mail Operations" + "Webhook Event Log" ], - "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": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", "requestBody": { "required": true, "content": { "application/json": { "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.", - "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" - ], + "aggregations": { "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" + "$ref": "#/components/schemas/Aggregation" } } }, - "type": "object" + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "The mail was sent successful", + "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": { - "size": { - "description": "Length of the email message", + "total": { "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "type": "object" + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/mail-template/validate": { + "/_action/validation/email": { "post": { "tags": [ - "Mail Operations" + "Email support validation" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", + "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." + } + ] + } + } + } + } + } + } + }, + "/_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, + "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": [] + } + } + } + } + } + } + }, + "/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/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" + ] + } + ] + } + }, + "/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." + } + } + } + }, + "/_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" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/_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/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": { @@ -75165,225 +76126,806 @@ "contentPlain" ], "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "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" + } + } + } + }, + "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/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": { + "$ref": "#/components/schemas/MediaId" + } + }, + { + "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/media/upload": { + "post": { + "tags": [ + "Asset Management" + ], + "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" }, - "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 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" + }, + "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" + } } }, - "type": "object" + "required": [ + "url", + "mimeType" + ] } } } }, "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "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/mail-template/build": { + "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ - "Mail Operations" + "Asset Management" + ], + "summary": "Add external thumbnails to media", + "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", + "operationId": "addExternalThumbnails", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be attached to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", "requestBody": { "required": true, "content": { "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" - }, - "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" + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } } - }, - "type": "object" + } } } } }, + "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": "The rendered preview of the mail template.", + "description": "Thumbnails deleted successfully", "content": { "application/json": { "schema": { - "type": "string" + "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/order_transaction_capture_refund/{refundId}": { + "/_action/media/{mediaId}/video-cover": { "post": { "tags": [ - "Order Management" + "Asset Management" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "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": "refundId", + "name": "mediaId", "in": "path", - "description": "Identifier of the order transaction capture refund.", "required": true, + "description": "ID of the video media entity", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/MediaId" } } ], + "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": "Refund was successful" + "description": "Video cover assigned or removed successfully" }, "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "description": "Invalid request" } } } }, - "/_info/openapi3.json": { - "get": { + "/_action/indexing": { + "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", + "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": "type", - "in": "query", - "description": "Type of the api", + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, "schema": { "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "pattern": "^[0-9a-f]{32}$" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "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/events.json": { + "/_action/state-machine/{entityName}/{entityId}/state": { "get": { "tags": [ - "System Info & Health Check" + "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" + } + } ], - "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": "Available transitions for the current state.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" + "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" + } } - } - } - }, - "/_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." + "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." + } + } + } + } } - } - } - }, - "/_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." + "200": { + "description": "State transition applied successfully." }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." + "400": { + "description": "Unable to read the entity or entity field, or invalid transition." }, "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - }, - "/_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." + "description": "Forbidden. Missing privileges to access the entity." } } } @@ -75435,155 +76977,29 @@ } } }, - "/_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" - } - }, - "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" - } - } - } - } - } - } - }, - "/_action/media/{mediaId}/upload": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "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": "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": "mediaId", + "name": "orderDeliveryId", "in": "path", - "description": "Identifier of the media entity.", + "description": "Identifier of the order delivery.", "required": true, "schema": { - "$ref": "#/components/schemas/MediaId" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", - "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `png`", + "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" @@ -75591,184 +77007,82 @@ } ], "requestBody": { + "required": false, "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/media/upload": { - "post": { - "tags": [ - "Asset Management" - ], - "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" + "sendMail": { + "description": "Controls if a mail should be send to the customer." }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "mimeType": { + "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", - "description": "MIME type of the file" + "default": "stateId" }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } }, - "required": [ - "file" - ] + "type": "object" } } } }, "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" - } - } - } - } - } + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_action/media/upload_by_url": { + "/_action/order/document/download": { "post": { "tags": [ - "Asset Management" + "Document 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", + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", "requestBody": { + "description": "documentIds", "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": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" - } - }, - "required": [ - "url" - ] + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } } } }, "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "The documents.", "content": { - "application\\/json": { + "application/octet-stream": { "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" - } - } + "type": "string", + "format": "binary" } } } @@ -75776,213 +77090,293 @@ } } }, - "/_action/media/external-link": { + "/_action/order/document/{documentTypeName}/create": { "post": { "tags": [ - "Asset Management" + "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": "Create external media link", - "description": "Creates a new media entity that links to an external URL without downloading the file.", - "operationId": "externalLink", "requestBody": { + "description": "test", + "required": true, "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" - }, - "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": "array", + "items": { "type": "object", + "required": [ + "orderId", + "type" + ], "properties": { - "id": { + "orderId": { + "description": "Identifier of the order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "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": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + } } } }, - "/_action/media/{mediaId}/external-thumbnails": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ - "Asset Management" + "Order 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", + "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": "mediaId", + "name": "orderId", "in": "path", - "description": "ID of the external media entity the thumbnails will be attached to.", + "description": "Identifier of the order.", "required": true, "schema": { - "$ref": "#/components/schemas/MediaId" + "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": true, + "required": false, "content": { "application/json": { "schema": { - "type": "object", "properties": { - "thumbnails": { + "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", - "description": "List of external thumbnails to attach", "items": { - "$ref": "#/components/schemas/ExternalThumbnail" + "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" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } - } + }, + "type": "object" } } } }, "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" + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" } } - }, - "delete": { + } + }, + "/_action/sync": { + "post": { "tags": [ - "Asset Management" + "Bulk Operations" ], - "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", + "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": "mediaId", - "in": "path", - "description": "ID of the external media entity the thumbnails will be deleted from..", - "required": true, + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "$ref": "#/components/schemas/MediaId" + "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" + } + }, + "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": "Thumbnails deleted successfully", + "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "mediaId": { - "description": "ID of the media entity the thumbnails were deleted from.", - "$ref": "#/components/schemas/MediaId" + "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" } } } - }, - "400": { - "description": "Media is not an external media entity or path is missing" - }, - "404": { - "description": "Media entity not found" } } } }, - "/_action/media/{mediaId}/video-cover": { + "/_action/order/{orderId}/order-address": { "post": { "tags": [ - "Asset Management" + "Order address" ], - "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", + "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": "mediaId", + "name": "orderId", "in": "path", + "description": "Identifier of the order.", "required": true, - "description": "ID of the video media entity", "schema": { - "$ref": "#/components/schemas/MediaId" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], @@ -75992,158 +77386,126 @@ "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." + "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": "Video cover assigned or removed successfully" - }, - "400": { - "description": "Invalid request" + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + "/_action/user/logout": { + "post": { "tags": [ - "Document Management" + "Authorization & Authentication" ], - "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}$" - } + "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." }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" - } + "401": { + "description": "Unauthorized - the access token is missing or invalid." }, - { - "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" - } - } - } + "403": { + "description": "The authenticated source does not have a user ID associated." } } } }, - "/_action/document/{documentId}/upload": { + "/oauth/token": { "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" - } - } + "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" } }, @@ -76151,48 +77513,124 @@ } } } + }, + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_action/cache": { - "delete": { + "/oauth/sso/config": { + "get": { + "tags": [ + "Experimental", + "SSO Login configuration" + ], + "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" + } + } + } + } + } + } + }, + "operationId": "loadSsoLoginConfig" + } + }, + "/oauth/sso/code": { + "get": { + "tags": [ + "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": "Authorisation process continues", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "302": { + "description": "Experimental: Forwards to the Shopware admin" + } + }, + "operationId": "callBackWithCode" + } + }, + "/_action/scheduled-task/run": { + "post": { "tags": [ "System Operations" ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/cache-delayed": { - "delete": { + "/_action/scheduled-task/min-run-interval": { + "get": { "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 - } - } - ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } @@ -76273,49 +77711,48 @@ } } }, - "/_action/cleanup": { - "delete": { + "/_info/openapi3.json": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "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." + "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" + ] + } } - } - } - }, - "/_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." + "$ref": "#/components/responses/OpenApi3" } } } }, - "/_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", @@ -76323,14 +77760,53 @@ } } ], + "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": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "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" @@ -76339,439 +77815,150 @@ } }, "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" - } - } - } + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." } } } }, - "/_action/state-machine/{entityName}/{entityId}/state": { - "get": { + "/_action/cache": { + "delete": { "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" - } - } + "System Operations" ], + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "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." + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { - "post": { + "/_action/cache-delayed": { + "delete": { "tags": [ - "State Machine" + "System Operations" ], - "summary": "Transition an entity to a new state", - "description": "Changes the entity state by applying the given transition.", - "operationId": "transitionEntityState", + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "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", + "name": "refreshOpenSearch", "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, + "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": "string", - "default": "stateId" + "type": "boolean", + "default": false } } ], - "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." + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_proxy/generate-imitate-customer-token": { - "post": { + "/oauth/sso/auth": { + "get": { "tags": [ - "Customer impersonation" + "Experimental", + "SSO Login forward" ], - "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: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" - } - } - } + "302": { + "description": "Experimental: Forwards to SSO login Page" } } } }, - "/_action/scheduled-task/run": { - "post": { + "/_info/is-sso": { + "get": { "tags": [ - "System Operations" + "Experimental", + "Is SSO environment" ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", + "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 a success message indicating a successful run.", - "content": { - "application/json": { - "schema": { - "properties": { - "message": { - "description": "Success message", - "type": "string" - } - }, - "type": "object" - } - } - } + "description": "Experimental: Returns if it is a SSO environment or not" } } } }, - "/_action/scheduled-task/min-run-interval": { - "get": { + "/_action/sso/invite-user": { + "post": { "tags": [ - "System Operations" + "Experimental", + "Invite a new SSO user" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "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": "Returns the minimum interval.", - "content": { - "application/json": { - "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" - } - } - } + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" } } } }, - "/_action/increment/{pool}": { - "post": { + "/_action/cache_info": { + "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" - } - } + "System Operations" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to increment in the pool." - } - } - } - } - } - }, + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "Successfully incremented the value", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "success": { - "type": "boolean", - "example": true + "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" } } } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" } } - }, + } + }, + "/_info/queue.json": { "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 - } - } + "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": "List of increment values", + "description": "Message queue statistics returned.", "content": { "application/json": { "schema": { @@ -76779,627 +77966,493 @@ "items": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "The increment key" + "description": "Fully qualified class name of the message." }, - "count": { + "size": { "type": "integer", - "description": "The current count value" + "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 + } + ] } } - }, - "400": { - "description": "Bad request - cluster parameter missing" } } } }, - "/_action/decrement/{pool}": { - "post": { + "/_info/version": { + "get": { "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" - } - } + "System Info & Health Check" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to decrement in the pool." - } - } - } - } - } - }, + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "Successfully decremented the value", + "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "success": { - "type": "boolean", - "example": true + "version": { + "description": "The Shopware version.", + "type": "string" } - } + }, + "type": "object" } } } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, - "/_action/reset-increment/{pool}": { - "post": { + "/_info/flow-actions.json": { + "get": { "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" - } - } + "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." - } - } - } - } - } - }, + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "Successfully reset the increment values", + "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } - }, - "400": { - "description": "Bad request - cluster parameter missing" } } } }, - "/_action/delete-increment/{pool}": { - "delete": { + "/_info/events.json": { + "get": { "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" - } - } + "System Info & Health Check" ], - "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." - } + "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" } } } } - }, - "responses": { - "204": { - "description": "Successfully deleted the increment keys" - }, - "400": { - "description": "Bad request - invalid keys parameter or cluster parameter missing" - } } } }, - "/_action/validation/email": { - "post": { + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", "tags": [ - "Email support validation" + "System Info & Health Check" ], - "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.", + "200": { + "description": "Successful operation", "content": { "application/json": { "schema": { + "type": "object", + "required": [ + "endpoints" + ], "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." + "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" }, - "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." - } - ] - } - } - } + "500": { + "description": "Application is not working properly" } } } }, - "/_action/order/{orderId}/order-address": { - "post": { + "/_info/system-health-check": { + "get": { "tags": [ - "Order address" + "System Info & Health Check" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "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": { - "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" + "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 } - ] + } } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" + } + } } } } } }, - "required": 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 a no content response indicating that the update has been made." + "description": "Returns an empty response indicating that the message dispatched." } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/_action/increment/{pool}": { + "post": { "tags": [ - "Document Management" + "Increment Storage" ], - "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": "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": "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": "pool", "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": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", "required": true, "schema": { "type": "string" } }, { - "name": "preview", + "name": "cluster", "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "description": "Optional cluster identifier for the increment operation.", "required": false, "schema": { - "type": "boolean" + "type": "string" } } ], - "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to increment in the pool." + } } } } - }, - "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.", + "description": "Successfully incremented the value", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" + "success": { + "type": "boolean", + "example": true } - }, - "type": "object" + } } } } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" } } - } - }, - "/_info/flow-actions.json": { + }, "get": { "tags": [ - "System Info & Health Check" + "Increment Storage" ], - "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": "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" } - } - } - } - }, - "/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" - ] + "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": "A JSON object containing requested privileges.", + "description": "List of increment values", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The increment key" + }, + "count": { + "type": "integer", + "description": "The current count value" } } } - }, - "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 - cluster parameter missing" } } } }, - "/app-system/{appName}/privileges/accepted": { - "get": { + "/_action/decrement/{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": "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": "appName", + "name": "pool", "in": "path", + "description": "The name of the increment pool.", "required": true, "schema": { "type": "string" } - } - ], - "security": [ + }, { - "oAuth": [ - "admin" - ] + "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": "A JSON object containing accepted privileges.", + "description": "Successfully decremented the value", "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 - key parameter missing or cluster parameter missing" } } } }, - "/app-system/{appName}/privileges": { - "patch": { + "/_action/reset-increment/{pool}": { + "post": { "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": "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" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", "required": true, "schema": { "type": "string" @@ -77407,217 +78460,151 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "accept": { - "type": "array", - "items": { - "type": "string" - } - }, - "revoke": { - "type": "array", - "items": { - "type": "string" - } + "key": { + "type": "string", + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." } } - }, - "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." + "200": { + "description": "Successfully reset the increment values", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } }, "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 - cluster parameter missing" } - ] + } } }, - "/app-system/shop/verify": { - "get": { + "/_action/delete-increment/{pool}": { + "delete": { "tags": [ - "App System", - "Public" + "Increment Storage" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", "parameters": [ { - "name": "runId", - "in": "query", - "description": "A unique identifier used to look up the token", + "name": "pool", + "in": "path", + "description": "The name of the increment pool to delete keys from.", "required": true, "schema": { "type": "string" } }, { - "name": "token", + "name": "cluster", "in": "query", - "description": "A unique identifier", + "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": "An empty response signalling successful verification." + "description": "Successfully deleted the increment keys" }, "400": { - "description": "Malformed request or unsuccessful verification." + "description": "Bad request - invalid keys parameter or cluster parameter missing" } } } }, - "/_info/queue.json": { - "get": { + "/_action/container_cache": { + "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 container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "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 container cache is cleared." } } } }, - "/_action/system-config": { + "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ - "System Config" - ], - "summary": "Get configuration values", - "description": "Returns the configuration values for the given domain and optional sales channel.", - "operationId": "getConfigurationValues", + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", "parameters": [ { - "name": "domain", - "in": "query", - "description": "The configuration domain.", + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "salesChannelId", - "in": "query", - "description": "The sales channel ID to scope the configuration to.", + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, "schema": { "type": "string" } }, { - "name": "inherit", + "name": "download", "in": "query", - "description": "Whether to include inherited (global) values.", + "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 @@ -77626,249 +78613,375 @@ ], "responses": { "200": { - "description": "Returns the configuration values as a key-value object." + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } } - }, + } + }, + "/_action/document/{documentId}/upload": { "post": { "tags": [ - "System Config" + "Document Management" ], - "summary": "Save configuration values", - "description": "Saves the given configuration key-value pairs for the given sales channel.", - "operationId": "saveConfiguration", + "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": "salesChannelId", + "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": "The sales channel ID to scope the configuration to.", + "description": "Name of the uploaded file.", + "required": true, "schema": { "type": "string" } }, { - "name": "silent", + "name": "extension", "in": "query", - "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, "schema": { - "type": "boolean", - "default": false + "type": "string" } } ], "requestBody": { - "description": "Key-value pairs of configuration values to save.", - "required": true, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { - "type": "object", - "additionalProperties": true + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } + }, + "type": "object" } } } }, "responses": { - "204": { - "description": "Configuration saved successfully." + "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/system-config/check": { + "/_action/number-range/reserve/{type}/{saleschannel}": { "get": { "tags": [ - "System Config" + "Document Management" ], - "summary": "Check configuration", - "description": "Checks if a configuration domain exists.", - "operationId": "checkConfiguration", + "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": "domain", - "in": "query", - "description": "The configuration domain to check.", + "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": "Returns whether the configuration domain exists." + "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/system-config/schema": { + "/consents": { "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" - } - } + "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": "Returns the configuration schema." + "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", + "acceptedUntil": "2024-01-15T10:20:30Z", + "acceptedRevision": "2026-02-01", + "latestRevision": "2026-02-01" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "unset", + "actor": null, + "updatedAt": null, + "acceptedUntil": null, + "acceptedRevision": null, + "latestRevision": null + } + } + } + } + } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/system-config/batch": { + "/consents/accept": { "post": { "tags": [ - "System Config" + "Consent Management", + "Experimental" ], - "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 + "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" + }, + "revision": { + "type": [ + "string", + "null" + ], + "description": "Optional accepted revision. Only the consent definition's latest revision is accepted. When omitted, the latest revision is used automatically." + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics", + "revision": "2026-02-01" + } + } + } + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } } + }, + "400": { + "description": "Bad request - Consent revision is invalid for current acceptance" + }, + "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": { - "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 + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" } } } } }, "responses": { - "204": { - "description": "Configuration saved successfully." + "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" } } } }, - "/_info/config": { - "get": { + "/_proxy/generate-imitate-customer-token": { + "post": { "tags": [ - "System Info & Health Check" + "Customer impersonation" ], - "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", + "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": "Public runtime configuration & feature metadata returned.", + "description": "The generated customer impersonation token.", "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" + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" } }, - "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": [] + "type": "object" } } } @@ -85928,6 +87041,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "group": { @@ -86738,6 +87885,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" @@ -88949,6 +90130,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -88959,9 +90143,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -89089,6 +90270,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", @@ -89099,10 +90284,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." @@ -92146,6 +93327,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -92271,6 +93455,9 @@ "type": "boolean", "description": "Unused field. To be removed in future." }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string", "description": "Name of the sender in the mail." @@ -93661,6 +94848,37 @@ }, "type": "object" }, + "productOpenGraphImages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } + } + } + } + }, + "type": "object" + }, "orderLineItems": { "properties": { "links": { @@ -94178,6 +95396,12 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, "orderLineItems": { "type": "array", "items": { @@ -96817,6 +98041,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -97657,6 +98915,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" @@ -102645,6 +103937,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -102881,6 +104178,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -103156,6 +104459,36 @@ }, "type": "object" }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, "featureSet": { "properties": { "links": { @@ -103944,6 +105277,11 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page's version." }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -104203,6 +105541,12 @@ }, "description": "List of additional keywords in the search." }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -104272,6 +105616,10 @@ "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, @@ -105435,6 +106783,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -105701,6 +107053,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -108296,7 +109652,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -108408,7 +109769,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -111670,6 +113036,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -113055,6 +114483,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -113910,6 +115400,298 @@ }, "type": "object" }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -120612,6 +122394,111 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -120830,271 +122717,40 @@ ], "additionalProperties": false }, - "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" - ] - }, - "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" - ] - } - ] - }, - "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" + } } } } }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } - } - }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -121815,6 +123471,156 @@ "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", @@ -121859,97 +123665,87 @@ } } }, - "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" - } - }, - "extensions": { - "type": "array", - "description": "Internal field.", - "items": { - "type": "string" - } - } - } - } - }, - "ConsentState": { + "Price": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], + "description": "Price object", "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { + "currencyId": { "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" + "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" + "gross": { + "description": "", + "type": "number" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "net": { + "description": "", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "linked": { + "description": "", + "type": "boolean" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "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" + ] }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" + "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" + ] }, "Cart": { "properties": { @@ -124232,6 +126028,14 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/adminapi.summary.json b/adminapi.summary.json index bbc9b45..c35e1e1 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -174,6 +174,8 @@ "/aggregate/sales-channel", "/aggregate/sales-channel-analytics", "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-tracking-customer", + "/aggregate/sales-channel-tracking-order", "/aggregate/sales-channel-type", "/aggregate/salutation", "/aggregate/scheduled-task", @@ -428,6 +430,10 @@ "/sales-channel-analytics/{id}", "/sales-channel-domain", "/sales-channel-domain/{id}", + "/sales-channel-tracking-customer", + "/sales-channel-tracking-customer/{id}", + "/sales-channel-tracking-order", + "/sales-channel-tracking-order/{id}", "/sales-channel-type", "/sales-channel-type/{id}", "/sales-channel/{id}", @@ -546,6 +552,8 @@ "/search/sales-channel", "/search/sales-channel-analytics", "/search/sales-channel-domain", + "/search/sales-channel-tracking-customer", + "/search/sales-channel-tracking-order", "/search/sales-channel-type", "/search/salutation", "/search/scheduled-task", @@ -922,6 +930,10 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", From 113fa8b3de41f7aea9f52b1424a571ee8112a5e4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Apr 2026 16:47:57 +0200 Subject: [PATCH 07/12] [create-pull-request] automated change (#470) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 46173 ++++++++++++++----------- SwagCommercial-adminapi.summary.json | 36 +- 2 files changed, 25445 insertions(+), 20764 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 905f06f..22c2de5 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -16245,14 +16245,15 @@ } } }, - "/custom-price": { + "/bundle-discount": { "get": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "List with basic information of Custom Price resources.", - "description": "", - "operationId": "getCustomPriceList", + "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", @@ -16281,7 +16282,7 @@ ], "responses": { "200": { - "description": "List of Custom Price resources.", + "description": "List of Bundle Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16300,7 +16301,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } ] @@ -16314,16 +16315,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-price?limit=25" + "example": "/bundle-discount?limit=25" }, "last": { - "example": "/custom-price?limit=25&page=11" + "example": "/bundle-discount?limit=25&page=11" }, "next": { - "example": "/custom-price?limit=25&page=4" + "example": "/bundle-discount?limit=25&page=4" }, "prev": { - "example": "/custom-price?limit=25&page=2" + "example": "/bundle-discount?limit=25&page=2" } } } @@ -16344,7 +16345,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16359,11 +16360,12 @@ }, "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Create a new Custom Price resources.", - "description": "", - "operationId": "createCustomPrice", + "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", @@ -16382,14 +16384,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16401,7 +16403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16416,7 +16418,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16432,14 +16434,15 @@ } } }, - "/search/custom-price": { + "/search/bundle-discount": { "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Search for the Custom Price resources.", - "description": "", - "operationId": "searchCustomPrice", + "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", @@ -16467,7 +16470,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16481,7 +16484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16499,7 +16502,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16516,19 +16519,20 @@ } } }, - "/custom-price/{id}": { + "/bundle-discount/{id}": { "get": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Detailed information about a Custom Price resource.", - "description": "", - "operationId": "getCustomPrice", + "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 custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16538,7 +16542,7 @@ ], "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16550,7 +16554,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16565,7 +16569,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16582,16 +16586,17 @@ }, "delete": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Delete a Custom Price resource.", - "description": "", - "operationId": "deleteCustomPrice", + "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 custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16622,16 +16627,17 @@ }, "patch": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Partially update information about a Custom Price resource.", - "description": "", - "operationId": "updateCustomPrice", + "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 custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16649,18 +16655,18 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Price resource.", + "description": "Partially update information about a Bundle Discount resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16672,7 +16678,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16687,7 +16693,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16706,14 +16712,15 @@ } } }, - "/aggregate/custom-price": { + "/aggregate/bundle-discount": { "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Aggregate for the Custom Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomPrice", + "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": { @@ -16737,7 +16744,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16751,7 +16758,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16769,7 +16776,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16786,14 +16793,15 @@ } } }, - "/customer-specific-features": { + "/bundle-item": { "get": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "List with basic information of Customer Specific Features resources.", - "description": "", - "operationId": "getCustomerSpecificFeaturesList", + "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", @@ -16822,7 +16830,7 @@ ], "responses": { "200": { - "description": "List of Customer Specific Features resources.", + "description": "List of Bundle Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16841,7 +16849,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } ] @@ -16855,16 +16863,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-specific-features?limit=25" + "example": "/bundle-item?limit=25" }, "last": { - "example": "/customer-specific-features?limit=25&page=11" + "example": "/bundle-item?limit=25&page=11" }, "next": { - "example": "/customer-specific-features?limit=25&page=4" + "example": "/bundle-item?limit=25&page=4" }, "prev": { - "example": "/customer-specific-features?limit=25&page=2" + "example": "/bundle-item?limit=25&page=2" } } } @@ -16885,7 +16893,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16900,11 +16908,12 @@ }, "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Create a new Customer Specific Features resources.", - "description": "", - "operationId": "createCustomerSpecificFeatures", + "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", @@ -16923,14 +16932,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -16942,7 +16951,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16957,7 +16966,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16973,14 +16982,15 @@ } } }, - "/search/customer-specific-features": { + "/search/bundle-item": { "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Search for the Customer Specific Features resources.", - "description": "", - "operationId": "searchCustomerSpecificFeatures", + "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", @@ -17008,7 +17018,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17022,7 +17032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17040,7 +17050,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17057,19 +17067,20 @@ } } }, - "/customer-specific-features/{id}": { + "/bundle-item/{id}": { "get": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Detailed information about a Customer Specific Features resource.", - "description": "", - "operationId": "getCustomerSpecificFeatures", + "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 customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17079,7 +17090,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17091,7 +17102,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17106,7 +17117,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17123,16 +17134,17 @@ }, "delete": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Delete a Customer Specific Features resource.", - "description": "", - "operationId": "deleteCustomerSpecificFeatures", + "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 customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17163,16 +17175,17 @@ }, "patch": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Partially update information about a Customer Specific Features resource.", - "description": "", - "operationId": "updateCustomerSpecificFeatures", + "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 customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17190,18 +17203,18 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Specific Features resource.", + "description": "Partially update information about a Bundle Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17213,7 +17226,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17228,7 +17241,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17247,14 +17260,15 @@ } } }, - "/aggregate/customer-specific-features": { + "/aggregate/bundle-item": { "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Aggregate for the Customer Specific Features resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerSpecificFeatures", + "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": { @@ -17278,7 +17292,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17292,7 +17306,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17310,7 +17324,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17327,14 +17341,14 @@ } } }, - "/media-ai-tag": { + "/custom-price": { "get": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "List with basic information of Media Ai Tag resources.", + "summary": "List with basic information of Custom Price resources.", "description": "", - "operationId": "getMediaAiTagList", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -17363,7 +17377,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17382,7 +17396,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -17396,16 +17410,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -17426,7 +17440,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17441,11 +17455,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Create a new Media Ai Tag resources.", + "summary": "Create a new Custom Price resources.", "description": "", - "operationId": "createMediaAiTag", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -17464,14 +17478,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17483,7 +17497,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17498,7 +17512,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17514,14 +17528,14 @@ } } }, - "/search/media-ai-tag": { + "/search/custom-price": { "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Search for the Media Ai Tag resources.", + "summary": "Search for the Custom Price resources.", "description": "", - "operationId": "searchMediaAiTag", + "operationId": "searchCustomPrice", "parameters": [ { "name": "sw-include-search-info", @@ -17549,7 +17563,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17563,7 +17577,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17581,7 +17595,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17598,19 +17612,19 @@ } } }, - "/media-ai-tag/{id}": { + "/custom-price/{id}": { "get": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Detailed information about a Media Ai Tag resource.", + "summary": "Detailed information about a Custom Price resource.", "description": "", - "operationId": "getMediaAiTag", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17620,7 +17634,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17632,7 +17646,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17647,7 +17661,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17664,16 +17678,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Delete a Media Ai Tag resource.", + "summary": "Delete a Custom Price resource.", "description": "", - "operationId": "deleteMediaAiTag", + "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17704,16 +17718,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Partially update information about a Media Ai Tag resource.", + "summary": "Partially update information about a Custom Price resource.", "description": "", - "operationId": "updateMediaAiTag", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17731,18 +17745,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a Custom Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17754,7 +17768,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17769,7 +17783,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17788,14 +17802,14 @@ } } }, - "/aggregate/media-ai-tag": { + "/aggregate/custom-price": { "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Aggregate for the Media Ai Tag resources.", + "summary": "Aggregate for the Custom Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaAiTag", + "operationId": "aggregateCustomPrice", "requestBody": { "required": true, "content": { @@ -17819,7 +17833,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17833,7 +17847,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17851,7 +17865,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17868,14 +17882,14 @@ } } }, - "/order-product-warehouse": { + "/customer-specific-features": { "get": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "List with basic information of Order Product Warehouse resources.", + "summary": "List with basic information of Customer Specific Features resources.", "description": "", - "operationId": "getOrderProductWarehouseList", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -17904,7 +17918,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17923,7 +17937,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -17937,16 +17951,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -17967,7 +17981,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -17982,11 +17996,11 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Create a new Order Product Warehouse resources.", + "summary": "Create a new Customer Specific Features resources.", "description": "", - "operationId": "createOrderProductWarehouse", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -18005,14 +18019,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18024,7 +18038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18039,7 +18053,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18055,14 +18069,14 @@ } } }, - "/search/order-product-warehouse": { + "/search/customer-specific-features": { "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Search for the Order Product Warehouse resources.", + "summary": "Search for the Customer Specific Features resources.", "description": "", - "operationId": "searchOrderProductWarehouse", + "operationId": "searchCustomerSpecificFeatures", "parameters": [ { "name": "sw-include-search-info", @@ -18090,7 +18104,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18104,7 +18118,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18122,7 +18136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18139,19 +18153,19 @@ } } }, - "/order-product-warehouse/{id}": { + "/customer-specific-features/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Detailed information about a Order Product Warehouse resource.", + "summary": "Detailed information about a Customer Specific Features resource.", "description": "", - "operationId": "getOrderProductWarehouse", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18161,7 +18175,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18173,7 +18187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18188,7 +18202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18205,16 +18219,16 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Delete a Order Product Warehouse resource.", + "summary": "Delete a Customer Specific Features resource.", "description": "", - "operationId": "deleteOrderProductWarehouse", + "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18245,16 +18259,16 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Partially update information about a Order Product Warehouse resource.", + "summary": "Partially update information about a Customer Specific Features resource.", "description": "", - "operationId": "updateOrderProductWarehouse", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18272,18 +18286,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18295,7 +18309,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18310,7 +18324,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18329,14 +18343,14 @@ } } }, - "/aggregate/order-product-warehouse": { + "/aggregate/customer-specific-features": { "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Aggregate for the Order Product Warehouse resources.", + "summary": "Aggregate for the Customer Specific Features resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderProductWarehouse", + "operationId": "aggregateCustomerSpecificFeatures", "requestBody": { "required": true, "content": { @@ -18360,7 +18374,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18374,7 +18388,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18392,7 +18406,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18409,14 +18423,14 @@ } } }, - "/order-return": { + "/media-ai-tag": { "get": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "List with basic information of Order Return resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getOrderReturnList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -18445,7 +18459,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18464,7 +18478,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -18478,16 +18492,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -18508,7 +18522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18523,11 +18537,11 @@ }, "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Create a new Order Return resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createOrderReturn", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -18546,14 +18560,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18565,7 +18579,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18580,7 +18594,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18596,14 +18610,14 @@ } } }, - "/search/order-return": { + "/search/media-ai-tag": { "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Search for the Order Return resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchOrderReturn", + "operationId": "searchMediaAiTag", "parameters": [ { "name": "sw-include-search-info", @@ -18631,7 +18645,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18645,7 +18659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18663,7 +18677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18680,19 +18694,19 @@ } } }, - "/order-return/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Detailed information about a Order Return resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getOrderReturn", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18702,7 +18716,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18714,7 +18728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18729,7 +18743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18746,16 +18760,16 @@ }, "delete": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Delete a Order Return resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteOrderReturn", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18786,16 +18800,16 @@ }, "patch": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Partially update information about a Order Return resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateOrderReturn", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18813,18 +18827,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18836,7 +18850,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18851,7 +18865,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18870,14 +18884,14 @@ } } }, - "/aggregate/order-return": { + "/aggregate/media-ai-tag": { "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Aggregate for the Order Return resources.", + "summary": "Aggregate for the Media Ai Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturn", + "operationId": "aggregateMediaAiTag", "requestBody": { "required": true, "content": { @@ -18901,7 +18915,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18915,7 +18929,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18933,7 +18947,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18950,14 +18964,14 @@ } } }, - "/order-return-line-item": { + "/order-product-warehouse": { "get": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "List with basic information of Order Return Line Item resources.", + "summary": "List with basic information of Order Product Warehouse resources.", "description": "", - "operationId": "getOrderReturnLineItemList", + "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", @@ -18986,7 +19000,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19005,7 +19019,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } ] @@ -19019,16 +19033,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/order-product-warehouse?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/order-product-warehouse?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/order-product-warehouse?limit=25&page=2" } } } @@ -19049,7 +19063,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19064,11 +19078,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Create a new Order Return Line Item resources.", + "summary": "Create a new Order Product Warehouse resources.", "description": "", - "operationId": "createOrderReturnLineItem", + "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", @@ -19087,14 +19101,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19106,7 +19120,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19121,7 +19135,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19137,14 +19151,14 @@ } } }, - "/search/order-return-line-item": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Search for the Order Return Line Item resources.", + "summary": "Search for the Order Product Warehouse resources.", "description": "", - "operationId": "searchOrderReturnLineItem", + "operationId": "searchOrderProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -19172,7 +19186,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19186,7 +19200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19204,7 +19218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19221,19 +19235,19 @@ } } }, - "/order-return-line-item/{id}": { + "/order-product-warehouse/{id}": { "get": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Detailed information about a Order Return Line Item resource.", + "summary": "Detailed information about a Order Product Warehouse resource.", "description": "", - "operationId": "getOrderReturnLineItem", + "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19243,7 +19257,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19255,7 +19269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19270,7 +19284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19287,16 +19301,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Delete a Order Return Line Item resource.", + "summary": "Delete a Order Product Warehouse resource.", "description": "", - "operationId": "deleteOrderReturnLineItem", + "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19327,16 +19341,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Partially update information about a Order Return Line Item resource.", + "summary": "Partially update information about a Order Product Warehouse resource.", "description": "", - "operationId": "updateOrderReturnLineItem", + "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19354,18 +19368,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19377,7 +19391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19392,7 +19406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19411,14 +19425,14 @@ } } }, - "/aggregate/order-return-line-item": { + "/aggregate/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Aggregate for the Order Return Line Item resources.", + "summary": "Aggregate for the Order Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItem", + "operationId": "aggregateOrderProductWarehouse", "requestBody": { "required": true, "content": { @@ -19442,7 +19456,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19456,7 +19470,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19474,7 +19488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19491,14 +19505,14 @@ } } }, - "/order-return-line-item-reason": { + "/order-return": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", + "summary": "List with basic information of Order Return resources.", "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", @@ -19527,7 +19541,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19546,7 +19560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } ] @@ -19560,16 +19574,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/order-return?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/order-return?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/order-return?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/order-return?limit=25&page=2" } } } @@ -19590,7 +19604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19605,11 +19619,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Create a new Order Return Line Item Reason resources.", + "summary": "Create a new Order Return resources.", "description": "", - "operationId": "createOrderReturnLineItemReason", + "operationId": "createOrderReturn", "parameters": [ { "name": "_response", @@ -19628,14 +19642,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19647,7 +19661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19662,7 +19676,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19678,14 +19692,14 @@ } } }, - "/search/order-return-line-item-reason": { + "/search/order-return": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Search for the Order Return Line Item Reason resources.", + "summary": "Search for the Order Return resources.", "description": "", - "operationId": "searchOrderReturnLineItemReason", + "operationId": "searchOrderReturn", "parameters": [ { "name": "sw-include-search-info", @@ -19713,7 +19727,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19727,7 +19741,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19745,7 +19759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19762,19 +19776,19 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/order-return/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", + "summary": "Detailed information about a Order Return resource.", "description": "", - "operationId": "getOrderReturnLineItemReason", + "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19784,7 +19798,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19796,7 +19810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19811,7 +19825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19828,16 +19842,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Delete a Order Return Line Item Reason resource.", + "summary": "Delete a Order Return resource.", "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19868,16 +19882,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", + "summary": "Partially update information about a Order Return resource.", "description": "", - "operationId": "updateOrderReturnLineItemReason", + "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19895,18 +19909,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a Order Return resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19918,7 +19932,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19933,7 +19947,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19952,14 +19966,14 @@ } } }, - "/aggregate/order-return-line-item-reason": { + "/aggregate/order-return": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Aggregate for the Order Return Line Item Reason resources.", + "summary": "Aggregate for the Order Return resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItemReason", + "operationId": "aggregateOrderReturn", "requestBody": { "required": true, "content": { @@ -19983,7 +19997,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19997,7 +20011,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20015,7 +20029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20032,14 +20046,14 @@ } } }, - "/order-warehouse-group": { + "/order-return-line-item": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of Order Return Line Item resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -20068,7 +20082,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20087,7 +20101,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -20101,16 +20115,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -20131,7 +20145,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20146,11 +20160,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new Order Return Line Item resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -20169,14 +20183,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20188,7 +20202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20203,7 +20217,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20219,14 +20233,14 @@ } } }, - "/search/order-warehouse-group": { + "/search/order-return-line-item": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Search for the Order Warehouse Group resources.", + "summary": "Search for the Order Return Line Item resources.", "description": "", - "operationId": "searchOrderWarehouseGroup", + "operationId": "searchOrderReturnLineItem", "parameters": [ { "name": "sw-include-search-info", @@ -20254,7 +20268,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20268,7 +20282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20286,7 +20300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20303,19 +20317,19 @@ } } }, - "/order-warehouse-group/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a Order Return Line Item resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20325,7 +20339,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20337,7 +20351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20352,7 +20366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20369,16 +20383,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a Order Return Line Item resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20409,16 +20423,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a Order Return Line Item resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20436,18 +20450,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20459,7 +20473,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20474,7 +20488,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20493,14 +20507,14 @@ } } }, - "/aggregate/order-warehouse-group": { + "/aggregate/order-return-line-item": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Aggregate for the Order Warehouse Group resources.", + "summary": "Aggregate for the Order Return Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderWarehouseGroup", + "operationId": "aggregateOrderReturnLineItem", "requestBody": { "required": true, "content": { @@ -20524,7 +20538,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20538,7 +20552,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20556,7 +20570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20573,14 +20587,14 @@ } } }, - "/product-review-summary": { + "/order-return-line-item-reason": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "List with basic information of Product Review Summary resources.", + "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", - "operationId": "getProductReviewSummaryList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -20609,7 +20623,7 @@ ], "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20628,7 +20642,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -20642,16 +20656,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review-summary?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/product-review-summary?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/product-review-summary?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/product-review-summary?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -20672,7 +20686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20687,11 +20701,11 @@ }, "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Create a new Product Review Summary resources.", + "summary": "Create a new Order Return Line Item Reason resources.", "description": "", - "operationId": "createProductReviewSummary", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -20710,14 +20724,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20729,7 +20743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20744,7 +20758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20760,14 +20774,14 @@ } } }, - "/search/product-review-summary": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Search for the Product Review Summary resources.", + "summary": "Search for the Order Return Line Item Reason resources.", "description": "", - "operationId": "searchProductReviewSummary", + "operationId": "searchOrderReturnLineItemReason", "parameters": [ { "name": "sw-include-search-info", @@ -20795,7 +20809,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20809,7 +20823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20827,7 +20841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20844,19 +20858,19 @@ } } }, - "/product-review-summary/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Detailed information about a Product Review Summary resource.", + "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "getProductReviewSummary", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20866,7 +20880,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20878,7 +20892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20893,7 +20907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20910,16 +20924,16 @@ }, "delete": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Delete a Product Review Summary resource.", + "summary": "Delete a Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteProductReviewSummary", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20950,16 +20964,16 @@ }, "patch": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Partially update information about a Product Review Summary resource.", + "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "updateProductReviewSummary", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20977,18 +20991,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21000,7 +21014,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21015,7 +21029,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21034,14 +21048,14 @@ } } }, - "/aggregate/product-review-summary": { + "/aggregate/order-return-line-item-reason": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Aggregate for the Product Review Summary resources.", + "summary": "Aggregate for the Order Return Line Item Reason resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReviewSummary", + "operationId": "aggregateOrderReturnLineItemReason", "requestBody": { "required": true, "content": { @@ -21065,7 +21079,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21079,7 +21093,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21097,7 +21111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21114,14 +21128,14 @@ } } }, - "/product-warehouse": { + "/order-warehouse-group": { "get": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "List with basic information of Product Warehouse resources.", + "summary": "List with basic information of Order Warehouse Group resources.", "description": "", - "operationId": "getProductWarehouseList", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -21150,7 +21164,7 @@ ], "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21169,7 +21183,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -21183,16 +21197,16 @@ "type": "object", "properties": { "first": { - "example": "/product-warehouse?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/product-warehouse?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/product-warehouse?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/product-warehouse?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -21213,7 +21227,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21228,11 +21242,11 @@ }, "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Create a new Product Warehouse resources.", + "summary": "Create a new Order Warehouse Group resources.", "description": "", - "operationId": "createProductWarehouse", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -21251,14 +21265,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21270,7 +21284,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21285,7 +21299,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21301,14 +21315,14 @@ } } }, - "/search/product-warehouse": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Search for the Product Warehouse resources.", + "summary": "Search for the Order Warehouse Group resources.", "description": "", - "operationId": "searchProductWarehouse", + "operationId": "searchOrderWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", @@ -21336,7 +21350,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21350,7 +21364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21368,7 +21382,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21385,19 +21399,19 @@ } } }, - "/product-warehouse/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Detailed information about a Product Warehouse resource.", + "summary": "Detailed information about a Order Warehouse Group resource.", "description": "", - "operationId": "getProductWarehouse", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21407,7 +21421,7 @@ ], "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21419,7 +21433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21434,7 +21448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21451,16 +21465,16 @@ }, "delete": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Delete a Product Warehouse resource.", + "summary": "Delete a Order Warehouse Group resource.", "description": "", - "operationId": "deleteProductWarehouse", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21491,16 +21505,16 @@ }, "patch": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Partially update information about a Product Warehouse resource.", + "summary": "Partially update information about a Order Warehouse Group resource.", "description": "", - "operationId": "updateProductWarehouse", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21518,18 +21532,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21541,7 +21555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21556,7 +21570,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21575,14 +21589,14 @@ } } }, - "/aggregate/product-warehouse": { + "/aggregate/order-warehouse-group": { "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Aggregate for the Product Warehouse resources.", + "summary": "Aggregate for the Order Warehouse Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductWarehouse", + "operationId": "aggregateOrderWarehouseGroup", "requestBody": { "required": true, "content": { @@ -21606,7 +21620,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21620,7 +21634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21638,7 +21652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21655,14 +21669,14 @@ } } }, - "/quote": { + "/product-review-summary": { "get": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of Product Review Summary resources.", + "description": "", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -21691,7 +21705,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21710,7 +21724,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -21724,16 +21738,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -21754,7 +21768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21769,11 +21783,11 @@ }, "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new Product Review Summary resources.", + "description": "", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -21792,14 +21806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21811,7 +21825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21826,7 +21840,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21842,14 +21856,14 @@ } } }, - "/search/quote": { + "/search/product-review-summary": { "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", + "summary": "Search for the Product Review Summary resources.", + "description": "", + "operationId": "searchProductReviewSummary", "parameters": [ { "name": "sw-include-search-info", @@ -21877,7 +21891,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21891,7 +21905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21909,7 +21923,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21926,19 +21940,19 @@ } } }, - "/quote/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a Product Review Summary resource.", + "description": "", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -21948,7 +21962,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21960,7 +21974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21975,7 +21989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21992,16 +22006,16 @@ }, "delete": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a Product Review Summary resource.", + "description": "", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22032,16 +22046,16 @@ }, "patch": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a Product Review Summary resource.", + "description": "", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22059,18 +22073,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22082,7 +22096,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22097,7 +22111,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22116,14 +22130,14 @@ } } }, - "/aggregate/quote": { + "/aggregate/product-review-summary": { "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Aggregate for the Quote resources.", + "summary": "Aggregate for the Product Review Summary resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuote", + "operationId": "aggregateProductReviewSummary", "requestBody": { "required": true, "content": { @@ -22147,7 +22161,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22161,7 +22175,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22179,7 +22193,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22196,14 +22210,14 @@ } } }, - "/quote-comment": { + "/product-warehouse": { "get": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "List with basic information of Quote Comment resources.", + "summary": "List with basic information of Product Warehouse resources.", "description": "", - "operationId": "getQuoteCommentList", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -22232,7 +22246,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22251,7 +22265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -22265,16 +22279,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -22295,7 +22309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22310,11 +22324,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Create a new Quote Comment resources.", + "summary": "Create a new Product Warehouse resources.", "description": "", - "operationId": "createQuoteComment", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -22333,14 +22347,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22352,7 +22366,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22367,7 +22381,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22383,14 +22397,14 @@ } } }, - "/search/quote-comment": { + "/search/product-warehouse": { "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Search for the Quote Comment resources.", + "summary": "Search for the Product Warehouse resources.", "description": "", - "operationId": "searchQuoteComment", + "operationId": "searchProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -22418,7 +22432,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22432,7 +22446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22450,7 +22464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22467,19 +22481,19 @@ } } }, - "/quote-comment/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Detailed information about a Quote Comment resource.", + "summary": "Detailed information about a Product Warehouse resource.", "description": "", - "operationId": "getQuoteComment", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22489,7 +22503,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22501,7 +22515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22516,7 +22530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22533,16 +22547,16 @@ }, "delete": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Delete a Quote Comment resource.", + "summary": "Delete a Product Warehouse resource.", "description": "", - "operationId": "deleteQuoteComment", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22573,16 +22587,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Partially update information about a Quote Comment resource.", + "summary": "Partially update information about a Product Warehouse resource.", "description": "", - "operationId": "updateQuoteComment", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22600,18 +22614,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22623,7 +22637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22638,7 +22652,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22657,14 +22671,14 @@ } } }, - "/aggregate/quote-comment": { + "/aggregate/product-warehouse": { "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Aggregate for the Quote Comment resources.", + "summary": "Aggregate for the Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteComment", + "operationId": "aggregateProductWarehouse", "requestBody": { "required": true, "content": { @@ -22688,7 +22702,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22702,7 +22716,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22720,7 +22734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22737,14 +22751,14 @@ } } }, - "/quote-delivery": { + "/quote": { "get": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "List with basic information of Quote Delivery resources.", + "summary": "List with basic information of Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -22773,7 +22787,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22792,7 +22806,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } ] @@ -22806,16 +22820,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -22836,7 +22850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22851,11 +22865,11 @@ }, "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Create a new Quote Delivery resources.", + "summary": "Create a new Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -22874,14 +22888,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -22893,7 +22907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22908,7 +22922,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22924,14 +22938,14 @@ } } }, - "/search/quote-delivery": { + "/search/quote": { "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Search for the Quote Delivery resources.", + "summary": "Search for the Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", + "operationId": "searchQuote", "parameters": [ { "name": "sw-include-search-info", @@ -22959,7 +22973,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -22973,7 +22987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22991,7 +23005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23008,19 +23022,19 @@ } } }, - "/quote-delivery/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Detailed information about a Quote Delivery resource.", + "summary": "Detailed information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23030,7 +23044,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23042,7 +23056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23057,7 +23071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23074,16 +23088,16 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Delete a Quote Delivery resource.", + "summary": "Delete a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23114,16 +23128,16 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Partially update information about a Quote Delivery resource.", + "summary": "Partially update information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23141,18 +23155,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Quote resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23164,7 +23178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23179,7 +23193,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23198,14 +23212,14 @@ } } }, - "/aggregate/quote-delivery": { + "/aggregate/quote": { "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Aggregate for the Quote Delivery resources.", + "summary": "Aggregate for the Quote resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDelivery", + "operationId": "aggregateQuote", "requestBody": { "required": true, "content": { @@ -23229,7 +23243,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23243,7 +23257,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23261,7 +23275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23278,14 +23292,14 @@ } } }, - "/quote-delivery-position": { + "/quote-comment": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "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 Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -23314,7 +23328,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23333,7 +23347,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -23347,16 +23361,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -23377,7 +23391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23392,11 +23406,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Create a new Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -23415,14 +23429,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23434,7 +23448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23449,7 +23463,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23465,14 +23479,14 @@ } } }, - "/search/quote-delivery-position": { + "/search/quote-comment": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Search for the Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", + "summary": "Search for the Quote Comment resources.", + "description": "", + "operationId": "searchQuoteComment", "parameters": [ { "name": "sw-include-search-info", @@ -23500,7 +23514,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23514,7 +23528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23532,7 +23546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23549,19 +23563,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Detailed information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23571,7 +23585,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23583,7 +23597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23598,7 +23612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23615,16 +23629,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Delete a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23655,16 +23669,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "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 Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23682,18 +23696,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23705,7 +23719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23720,7 +23734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23739,14 +23753,14 @@ } } }, - "/aggregate/quote-delivery-position": { + "/aggregate/quote-comment": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Aggregate for the Quote Delivery Position resources.", + "summary": "Aggregate for the Quote Comment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDeliveryPosition", + "operationId": "aggregateQuoteComment", "requestBody": { "required": true, "content": { @@ -23770,7 +23784,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23784,7 +23798,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23802,7 +23816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23819,14 +23833,14 @@ } } }, - "/quote-document": { + "/quote-delivery": { "get": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "List with basic information of Quote Document resources.", - "description": "", - "operationId": "getQuoteDocumentList", + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -23855,7 +23869,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23874,7 +23888,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -23888,16 +23902,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -23918,7 +23932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -23933,11 +23947,11 @@ }, "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Create a new Quote Document resources.", - "description": "", - "operationId": "createQuoteDocument", + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -23956,14 +23970,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -23975,7 +23989,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -23990,7 +24004,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24006,14 +24020,14 @@ } } }, - "/search/quote-document": { + "/search/quote-delivery": { "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Search for the Quote Document resources.", - "description": "", - "operationId": "searchQuoteDocument", + "summary": "Search for the Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDelivery", "parameters": [ { "name": "sw-include-search-info", @@ -24041,7 +24055,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24055,7 +24069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24073,7 +24087,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24090,19 +24104,19 @@ } } }, - "/quote-document/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Detailed information about a Quote Document resource.", - "description": "", - "operationId": "getQuoteDocument", + "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_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24112,7 +24126,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24124,7 +24138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24139,7 +24153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24156,16 +24170,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Delete a Quote Document resource.", - "description": "", - "operationId": "deleteQuoteDocument", + "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_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24196,16 +24210,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Partially update information about a Quote Document resource.", - "description": "", - "operationId": "updateQuoteDocument", + "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_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24223,18 +24237,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24246,7 +24260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24261,7 +24275,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24280,14 +24294,14 @@ } } }, - "/aggregate/quote-document": { + "/aggregate/quote-delivery": { "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Aggregate for the Quote Document resources.", + "summary": "Aggregate for the Quote Delivery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDocument", + "operationId": "aggregateQuoteDelivery", "requestBody": { "required": true, "content": { @@ -24311,7 +24325,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24325,7 +24339,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24343,7 +24357,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24360,14 +24374,14 @@ } } }, - "/quote-employee": { + "/quote-delivery-position": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "List with basic information of Quote Employee resources.", - "description": "", - "operationId": "getQuoteEmployeeList", + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", @@ -24396,7 +24410,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24415,7 +24429,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] @@ -24429,16 +24443,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/quote-delivery-position?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/quote-delivery-position?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/quote-delivery-position?limit=25&page=2" } } } @@ -24459,7 +24473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24474,11 +24488,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Create a new Quote Employee resources.", - "description": "", - "operationId": "createQuoteEmployee", + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", @@ -24497,14 +24511,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24516,7 +24530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24531,7 +24545,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24547,14 +24561,14 @@ } } }, - "/search/quote-employee": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Search for the Quote Employee resources.", - "description": "", - "operationId": "searchQuoteEmployee", + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", "parameters": [ { "name": "sw-include-search-info", @@ -24582,7 +24596,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24596,7 +24610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24614,7 +24628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24631,19 +24645,19 @@ } } }, - "/quote-employee/{id}": { + "/quote-delivery-position/{id}": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Detailed information about a Quote Employee resource.", - "description": "", - "operationId": "getQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24653,7 +24667,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24665,7 +24679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24680,7 +24694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24697,16 +24711,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Delete a Quote Employee resource.", - "description": "", - "operationId": "deleteQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24737,16 +24751,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Partially update information about a Quote Employee resource.", - "description": "", - "operationId": "updateQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24764,18 +24778,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24787,7 +24801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24802,7 +24816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24821,14 +24835,14 @@ } } }, - "/aggregate/quote-employee": { + "/aggregate/quote-delivery-position": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Aggregate for the Quote Employee resources.", + "summary": "Aggregate for the Quote Delivery Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteEmployee", + "operationId": "aggregateQuoteDeliveryPosition", "requestBody": { "required": true, "content": { @@ -24852,7 +24866,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24866,7 +24880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24884,7 +24898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24901,14 +24915,14 @@ } } }, - "/quote-line-item": { + "/quote-document": { "get": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "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 Document resources.", + "description": "", + "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", @@ -24937,7 +24951,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24956,7 +24970,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } ] @@ -24970,16 +24984,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/quote-document?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/quote-document?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/quote-document?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/quote-document?limit=25&page=2" } } } @@ -25000,7 +25014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25015,11 +25029,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "summary": "Create a new Quote Document resources.", + "description": "", + "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", @@ -25038,14 +25052,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25057,7 +25071,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25072,7 +25086,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25088,14 +25102,14 @@ } } }, - "/search/quote-line-item": { + "/search/quote-document": { "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Search for the Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", + "summary": "Search for the Quote Document resources.", + "description": "", + "operationId": "searchQuoteDocument", "parameters": [ { "name": "sw-include-search-info", @@ -25123,7 +25137,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25137,7 +25151,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25155,7 +25169,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25172,19 +25186,19 @@ } } }, - "/quote-line-item/{id}": { + "/quote-document/{id}": { "get": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "summary": "Detailed information about a Quote Document resource.", + "description": "", + "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25194,7 +25208,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25206,7 +25220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25221,7 +25235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25238,16 +25252,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "summary": "Delete a Quote Document resource.", + "description": "", + "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25278,16 +25292,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "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 Document resource.", + "description": "", + "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25305,18 +25319,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Quote Document resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25328,7 +25342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25343,7 +25357,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25362,14 +25376,14 @@ } } }, - "/aggregate/quote-line-item": { + "/aggregate/quote-document": { "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Aggregate for the Quote Line Item resources.", + "summary": "Aggregate for the Quote Document resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteLineItem", + "operationId": "aggregateQuoteDocument", "requestBody": { "required": true, "content": { @@ -25393,7 +25407,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25407,7 +25421,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25425,7 +25439,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25442,14 +25456,14 @@ } } }, - "/quote-transaction": { + "/quote-employee": { "get": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "List with basic information of Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", @@ -25478,7 +25492,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25497,7 +25511,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } ] @@ -25511,16 +25525,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/quote-employee?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/quote-employee?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/quote-employee?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/quote-employee?limit=25&page=2" } } } @@ -25541,7 +25555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25556,11 +25570,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Create a new Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", @@ -25579,14 +25593,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25598,7 +25612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25613,7 +25627,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25629,14 +25643,14 @@ } } }, - "/search/quote-transaction": { + "/search/quote-employee": { "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Search for the Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", + "summary": "Search for the Quote Employee resources.", + "description": "", + "operationId": "searchQuoteEmployee", "parameters": [ { "name": "sw-include-search-info", @@ -25664,7 +25678,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25678,7 +25692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25696,7 +25710,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25713,19 +25727,19 @@ } } }, - "/quote-transaction/{id}": { + "/quote-employee/{id}": { "get": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Detailed information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25735,7 +25749,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25747,7 +25761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25762,7 +25776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25779,16 +25793,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Delete a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25819,16 +25833,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Partially update information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25846,18 +25860,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Quote Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25869,7 +25883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25884,7 +25898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25903,14 +25917,14 @@ } } }, - "/aggregate/quote-transaction": { + "/aggregate/quote-employee": { "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Aggregate for the Quote Transaction resources.", + "summary": "Aggregate for the Quote Employee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteTransaction", + "operationId": "aggregateQuoteEmployee", "requestBody": { "required": true, "content": { @@ -25934,7 +25948,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25948,7 +25962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25966,7 +25980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25983,15 +25997,14 @@ } } }, - "/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", @@ -26020,7 +26033,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26039,7 +26052,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -26053,16 +26066,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" } } } @@ -26083,7 +26096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26098,12 +26111,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", @@ -26122,14 +26134,14 @@ "content": { "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": { @@ -26141,7 +26153,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26156,7 +26168,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26172,15 +26184,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", "parameters": [ { "name": "sw-include-search-info", @@ -26208,7 +26219,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26222,7 +26233,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26240,7 +26251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26257,20 +26268,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", @@ -26280,7 +26290,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26292,7 +26302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26307,7 +26317,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26324,17 +26334,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", @@ -26365,17 +26374,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", @@ -26393,18 +26401,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { "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": { @@ -26416,7 +26424,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26431,7 +26439,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26450,15 +26458,14 @@ } } }, - "/aggregate/spatial-render-config-size": { + "/aggregate/quote-line-item": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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 Quote Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialRenderConfigSize", + "operationId": "aggregateQuoteLineItem", "requestBody": { "required": true, "content": { @@ -26482,7 +26489,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26496,7 +26503,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26514,7 +26521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26531,15 +26538,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", @@ -26568,7 +26574,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26587,7 +26593,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -26601,16 +26607,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" } } } @@ -26631,7 +26637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26646,12 +26652,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", @@ -26670,14 +26675,14 @@ "content": { "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": { @@ -26689,7 +26694,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26704,7 +26709,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26720,15 +26725,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", "parameters": [ { "name": "sw-include-search-info", @@ -26756,7 +26760,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26770,7 +26774,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26788,7 +26792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26805,20 +26809,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", @@ -26828,7 +26831,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26840,7 +26843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26855,7 +26858,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26872,17 +26875,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", @@ -26913,17 +26915,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", @@ -26941,18 +26942,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { "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": { @@ -26964,7 +26965,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26979,7 +26980,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26998,15 +26999,14 @@ } } }, - "/aggregate/spatial-scene": { + "/aggregate/quote-transaction": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialScene", + "operationId": "aggregateQuoteTransaction", "requestBody": { "required": true, "content": { @@ -27030,7 +27030,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27044,7 +27044,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27062,7 +27062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27079,15 +27079,15 @@ } } }, - "/spatial-scene-camera": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { "name": "limit", @@ -27116,7 +27116,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Sales Channel Tracking Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27135,7 +27135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } ] @@ -27149,16 +27149,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/sales-channel-tracking-customer?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/sales-channel-tracking-customer?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/sales-channel-tracking-customer?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/sales-channel-tracking-customer?limit=25&page=2" } } } @@ -27179,7 +27179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27194,12 +27194,12 @@ }, "post": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { "name": "_response", @@ -27218,14 +27218,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -27237,7 +27237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27252,7 +27252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27268,15 +27268,15 @@ } } }, - "/search/spatial-scene-camera": { + "/search/sales-channel-tracking-customer": { "post": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -27304,7 +27304,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -27318,7 +27318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27336,7 +27336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27353,20 +27353,20 @@ } } }, - "/spatial-scene-camera/{id}": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -27376,7 +27376,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -27388,7 +27388,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27403,7 +27403,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27420,17 +27420,17 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -27461,17 +27461,17 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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", + "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -27489,18 +27489,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Sales Channel Tracking Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -27512,7 +27512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27527,7 +27527,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27546,15 +27546,15 @@ } } }, - "/aggregate/spatial-scene-camera": { + "/aggregate/sales-channel-tracking-customer": { "post": { "tags": [ - "Spatial Scene Camera", + "Sales Channel Tracking Customer", "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.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneCamera", + "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingCustomer", "requestBody": { "required": true, "content": { @@ -27578,7 +27578,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -27592,7 +27592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27610,7 +27610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -27627,15 +27627,15 @@ } } }, - "/spatial-scene-group": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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.", - "description": "", - "operationId": "getSpatialSceneGroupList", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ { "name": "limit", @@ -27664,7 +27664,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Group resources.", + "description": "List of Sales Channel Tracking Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27683,7 +27683,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } ] @@ -27697,16 +27697,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-group?limit=25" + "example": "/sales-channel-tracking-order?limit=25" }, "last": { - "example": "/spatial-scene-group?limit=25&page=11" + "example": "/sales-channel-tracking-order?limit=25&page=11" }, "next": { - "example": "/spatial-scene-group?limit=25&page=4" + "example": "/sales-channel-tracking-order?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-group?limit=25&page=2" + "example": "/sales-channel-tracking-order?limit=25&page=2" } } } @@ -27727,7 +27727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27742,12 +27742,12 @@ }, "post": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { "name": "_response", @@ -27766,14 +27766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -27785,7 +27785,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27800,7 +27800,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27816,15 +27816,15 @@ } } }, - "/search/spatial-scene-group": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { "name": "sw-include-search-info", @@ -27852,7 +27852,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -27866,7 +27866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27884,7 +27884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27901,20 +27901,20 @@ } } }, - "/spatial-scene-group/{id}": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -27924,7 +27924,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -27936,7 +27936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27951,7 +27951,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -27968,17 +27968,17 @@ }, "delete": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -28009,17 +28009,17 @@ }, "patch": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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.", - "description": "", - "operationId": "updateSpatialSceneGroup", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -28037,18 +28037,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Group resource.", + "description": "Partially update information about a Sales Channel Tracking Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -28060,7 +28060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -28075,7 +28075,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -28094,15 +28094,15 @@ } } }, - "/aggregate/spatial-scene-group": { + "/aggregate/sales-channel-tracking-order": { "post": { "tags": [ - "Spatial Scene Group", + "Sales Channel Tracking Order", "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", + "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { @@ -28126,7 +28126,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -28140,7 +28140,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -28158,7 +28158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -28175,15 +28175,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-render-config-size": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "getSpatialSceneLightList", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -28212,7 +28212,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28231,7 +28231,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -28245,16 +28245,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -28275,7 +28275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28290,12 +28290,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "createSpatialSceneLight", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -28314,14 +28314,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28333,7 +28333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28348,7 +28348,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28364,15 +28364,15 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "searchSpatialSceneLight", + "operationId": "searchSpatialRenderConfigSize", "parameters": [ { "name": "sw-include-search-info", @@ -28400,7 +28400,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28414,7 +28414,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28432,7 +28432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28449,20 +28449,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "getSpatialSceneLight", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28472,7 +28472,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28484,7 +28484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28499,7 +28499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28516,17 +28516,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "deleteSpatialSceneLight", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28557,17 +28557,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "updateSpatialSceneLight", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28585,18 +28585,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28608,7 +28608,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28623,7 +28623,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28642,15 +28642,15 @@ } } }, - "/aggregate/spatial-scene-light": { + "/aggregate/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Render Config Size", "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 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": "aggregateSpatialSceneLight", + "operationId": "aggregateSpatialRenderConfigSize", "requestBody": { "required": true, "content": { @@ -28674,7 +28674,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28688,7 +28688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28706,7 +28706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28723,15 +28723,15 @@ } } }, - "/spatial-scene-material": { + "/spatial-scene": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterialList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -28760,7 +28760,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Material resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28779,7 +28779,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -28793,16 +28793,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-material?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/spatial-scene-material?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/spatial-scene-material?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-material?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -28823,7 +28823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28838,12 +28838,12 @@ }, "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneMaterial", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -28862,14 +28862,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28881,7 +28881,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28896,7 +28896,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28912,15 +28912,15 @@ } } }, - "/search/spatial-scene-material": { + "/search/spatial-scene": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneMaterial", + "operationId": "searchSpatialScene", "parameters": [ { "name": "sw-include-search-info", @@ -28948,7 +28948,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28962,7 +28962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28980,7 +28980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28997,20 +28997,20 @@ } } }, - "/spatial-scene-material/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterial", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -29020,7 +29020,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -29032,7 +29032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29047,7 +29047,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29064,17 +29064,17 @@ }, "delete": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneMaterial", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -29105,17 +29105,17 @@ }, "patch": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneMaterial", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -29133,18 +29133,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Material resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -29156,7 +29156,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29171,7 +29171,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29190,15 +29190,15 @@ } } }, - "/aggregate/spatial-scene-material": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene", "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 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": "aggregateSpatialScene", "requestBody": { "required": true, "content": { @@ -29222,7 +29222,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -29236,7 +29236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29254,7 +29254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29271,15 +29271,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", @@ -29308,7 +29308,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29327,7 +29327,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -29341,16 +29341,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" } } } @@ -29371,7 +29371,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29386,12 +29386,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", @@ -29410,14 +29410,14 @@ "content": { "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": { @@ -29429,7 +29429,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29444,7 +29444,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29460,15 +29460,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", "parameters": [ { "name": "sw-include-search-info", @@ -29496,7 +29496,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29510,7 +29510,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29528,7 +29528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29545,20 +29545,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", @@ -29568,7 +29568,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29580,7 +29580,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29595,7 +29595,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29612,17 +29612,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", @@ -29653,17 +29653,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", @@ -29681,18 +29681,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "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": { @@ -29704,7 +29704,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29719,7 +29719,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29738,15 +29738,15 @@ } } }, - "/aggregate/spatial-scene-object": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "aggregateSpatialSceneObject", + "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -29770,7 +29770,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +29784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29802,7 +29802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29819,15 +29819,15 @@ } } }, - "/spatial-scene-primitive": { + "/spatial-scene-group": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "getSpatialScenePrimitiveList", + "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", @@ -29856,7 +29856,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Primitive resources.", + "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29875,7 +29875,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } ] @@ -29889,16 +29889,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-primitive?limit=25" + "example": "/spatial-scene-group?limit=25" }, "last": { - "example": "/spatial-scene-primitive?limit=25&page=11" + "example": "/spatial-scene-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene-primitive?limit=25&page=4" + "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-primitive?limit=25&page=2" + "example": "/spatial-scene-group?limit=25&page=2" } } } @@ -29919,7 +29919,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29934,12 +29934,12 @@ }, "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "createSpatialScenePrimitive", + "operationId": "createSpatialSceneGroup", "parameters": [ { "name": "_response", @@ -29958,14 +29958,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29977,7 +29977,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29992,7 +29992,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30008,15 +30008,15 @@ } } }, - "/search/spatial-scene-primitive": { + "/search/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "searchSpatialScenePrimitive", + "operationId": "searchSpatialSceneGroup", "parameters": [ { "name": "sw-include-search-info", @@ -30044,7 +30044,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -30058,7 +30058,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30076,7 +30076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30093,20 +30093,20 @@ } } }, - "/spatial-scene-primitive/{id}": { + "/spatial-scene-group/{id}": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "getSpatialScenePrimitive", + "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -30116,7 +30116,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -30128,7 +30128,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30143,7 +30143,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30160,17 +30160,17 @@ }, "delete": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "deleteSpatialScenePrimitive", + "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -30201,17 +30201,17 @@ }, "patch": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "updateSpatialScenePrimitive", + "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -30229,18 +30229,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Primitive resource.", + "description": "Partially update information about a Spatial Scene Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +30252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30267,7 +30267,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30286,15 +30286,15 @@ } } }, - "/aggregate/spatial-scene-primitive": { + "/aggregate/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Group", "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 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": "aggregateSpatialScenePrimitive", + "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { @@ -30318,7 +30318,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -30332,7 +30332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30350,7 +30350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -30367,15 +30367,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", @@ -30404,7 +30404,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30423,7 +30423,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -30437,16 +30437,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" } } } @@ -30467,7 +30467,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30482,12 +30482,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", @@ -30506,14 +30506,14 @@ "content": { "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": { @@ -30525,7 +30525,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30540,7 +30540,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30556,15 +30556,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", "parameters": [ { "name": "sw-include-search-info", @@ -30592,7 +30592,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30606,7 +30606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30624,7 +30624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30641,20 +30641,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", @@ -30664,7 +30664,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30676,7 +30676,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30691,7 +30691,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30708,17 +30708,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", @@ -30749,17 +30749,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", @@ -30777,18 +30777,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "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": { @@ -30800,7 +30800,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30815,7 +30815,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30834,15 +30834,15 @@ } } }, - "/aggregate/sso-provider": { + "/aggregate/spatial-scene-light": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "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 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": "aggregateSsoProvider", + "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -30866,7 +30866,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30880,7 +30880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30898,7 +30898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30915,15 +30915,15 @@ } } }, - "/sso-provider-customer": { + "/spatial-scene-material": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", @@ -30952,7 +30952,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30971,7 +30971,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] @@ -30985,16 +30985,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/spatial-scene-material?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/spatial-scene-material?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/spatial-scene-material?limit=25&page=2" } } } @@ -31015,7 +31015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31030,12 +31030,12 @@ }, "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", @@ -31054,14 +31054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -31073,7 +31073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31088,7 +31088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31104,15 +31104,15 @@ } } }, - "/search/sso-provider-customer": { + "/search/spatial-scene-material": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchSpatialSceneMaterial", "parameters": [ { "name": "sw-include-search-info", @@ -31140,7 +31140,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -31154,7 +31154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31172,7 +31172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31189,20 +31189,20 @@ } } }, - "/sso-provider-customer/{id}": { + "/spatial-scene-material/{id}": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -31212,7 +31212,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -31224,7 +31224,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31239,7 +31239,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31256,17 +31256,17 @@ }, "delete": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -31297,17 +31297,17 @@ }, "patch": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -31325,18 +31325,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -31348,7 +31348,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31363,7 +31363,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31382,15 +31382,15 @@ } } }, - "/aggregate/sso-provider-customer": { + "/aggregate/spatial-scene-material": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Material", "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.", + "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": "aggregateSsoProviderCustomer", + "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { @@ -31414,7 +31414,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -31428,7 +31428,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31446,7 +31446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -31463,14 +31463,15 @@ } } }, - "/subscription": { + "/spatial-scene-object": { "get": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "List with basic information of Subscription resources.", + "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": "getSubscriptionList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -31499,7 +31500,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31518,7 +31519,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -31532,16 +31533,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -31562,7 +31563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31577,11 +31578,12 @@ }, "post": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Create a new Subscription resources.", + "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": "createSubscription", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -31600,14 +31602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31619,7 +31621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31634,7 +31636,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31650,14 +31652,15 @@ } } }, - "/search/subscription": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Search for the Subscription resources.", + "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": "searchSubscription", + "operationId": "searchSpatialSceneObject", "parameters": [ { "name": "sw-include-search-info", @@ -31685,7 +31688,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31699,7 +31702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31717,7 +31720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31734,19 +31737,20 @@ } } }, - "/subscription/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Detailed information about a Subscription resource.", + "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": "getSubscription", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31756,7 +31760,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31768,7 +31772,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31783,7 +31787,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31800,16 +31804,17 @@ }, "delete": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Delete a Subscription resource.", + "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": "deleteSubscription", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31840,16 +31845,17 @@ }, "patch": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Partially update information about a Subscription resource.", + "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": "updateSubscription", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31867,18 +31873,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31890,7 +31896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31905,7 +31911,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31924,14 +31930,15 @@ } } }, - "/aggregate/subscription": { + "/aggregate/spatial-scene-object": { "post": { "tags": [ - "Subscription" + "Spatial Scene Object", + "Experimental" ], - "summary": "Aggregate for the Subscription resources.", + "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": "aggregateSubscription", + "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -31955,7 +31962,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31969,7 +31976,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31987,7 +31994,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -32004,14 +32011,15 @@ } } }, - "/subscription-address": { + "/spatial-scene-primitive": { "get": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "List with basic information of Subscription Address resources.", + "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": "getSubscriptionAddressList", + "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", @@ -32040,7 +32048,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32059,7 +32067,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] @@ -32073,16 +32081,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/spatial-scene-primitive?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/spatial-scene-primitive?limit=25&page=2" } } } @@ -32103,7 +32111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32118,11 +32126,12 @@ }, "post": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Create a new Subscription Address resources.", + "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": "createSubscriptionAddress", + "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", @@ -32141,14 +32150,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -32160,7 +32169,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32175,7 +32184,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32191,14 +32200,15 @@ } } }, - "/search/subscription-address": { + "/search/spatial-scene-primitive": { "post": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Search for the Subscription Address resources.", + "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": "searchSubscriptionAddress", + "operationId": "searchSpatialScenePrimitive", "parameters": [ { "name": "sw-include-search-info", @@ -32226,7 +32236,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -32240,7 +32250,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32258,7 +32268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32275,19 +32285,20 @@ } } }, - "/subscription-address/{id}": { + "/spatial-scene-primitive/{id}": { "get": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Detailed information about a Subscription Address resource.", + "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": "getSubscriptionAddress", + "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -32297,7 +32308,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -32309,7 +32320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32324,7 +32335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32341,16 +32352,17 @@ }, "delete": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Delete a Subscription Address resource.", + "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": "deleteSubscriptionAddress", + "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -32381,16 +32393,17 @@ }, "patch": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Partially update information about a Subscription Address resource.", + "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": "updateSubscriptionAddress", + "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -32408,18 +32421,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -32431,7 +32444,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32446,7 +32459,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32465,14 +32478,15 @@ } } }, - "/aggregate/subscription-address": { + "/aggregate/spatial-scene-primitive": { "post": { "tags": [ - "Subscription Address" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Aggregate for the Subscription Address resources.", + "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": "aggregateSubscriptionAddress", + "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { @@ -32496,7 +32510,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -32510,7 +32524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32528,7 +32542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32545,14 +32559,15 @@ } } }, - "/subscription-customer": { + "/sso-provider": { "get": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "List with basic information of Subscription Customer 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": "getSubscriptionCustomerList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -32581,7 +32596,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32600,7 +32615,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -32614,16 +32629,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -32644,7 +32659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32659,11 +32674,12 @@ }, "post": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Create a new Subscription Customer 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": "createSubscriptionCustomer", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -32682,14 +32698,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32701,7 +32717,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32716,7 +32732,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32732,14 +32748,15 @@ } } }, - "/search/subscription-customer": { + "/search/sso-provider": { "post": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Search for the Subscription Customer 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": "searchSubscriptionCustomer", + "operationId": "searchSsoProvider", "parameters": [ { "name": "sw-include-search-info", @@ -32767,7 +32784,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32781,7 +32798,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32799,7 +32816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32816,19 +32833,20 @@ } } }, - "/subscription-customer/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Detailed information about a Subscription Customer 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": "getSubscriptionCustomer", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32838,7 +32856,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32850,7 +32868,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32865,7 +32883,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32882,16 +32900,17 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Delete a Subscription Customer 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": "deleteSubscriptionCustomer", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32922,16 +32941,17 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Partially update information about a Subscription Customer 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": "updateSubscriptionCustomer", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32949,18 +32969,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32972,7 +32992,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32987,7 +33007,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -33006,14 +33026,15 @@ } } }, - "/aggregate/subscription-customer": { + "/aggregate/sso-provider": { "post": { "tags": [ - "Subscription Customer" + "Sso Provider", + "Experimental" ], - "summary": "Aggregate for the Subscription Customer resources.", + "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": "aggregateSubscriptionCustomer", + "operationId": "aggregateSsoProvider", "requestBody": { "required": true, "content": { @@ -33037,7 +33058,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -33051,7 +33072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -33069,7 +33090,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -33086,14 +33107,15 @@ } } }, - "/subscription-interval": { + "/sso-provider-customer": { "get": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "List with basic information of Subscription Interval 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": "getSubscriptionIntervalList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -33122,7 +33144,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33141,7 +33163,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -33155,16 +33177,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -33185,7 +33207,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33200,11 +33222,12 @@ }, "post": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Create a new Subscription Interval 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": "createSubscriptionInterval", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -33223,14 +33246,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33242,7 +33265,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33257,7 +33280,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33273,14 +33296,15 @@ } } }, - "/search/subscription-interval": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Search for the Subscription Interval 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": "searchSubscriptionInterval", + "operationId": "searchSsoProviderCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -33308,7 +33332,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33322,7 +33346,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33340,7 +33364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33357,19 +33381,20 @@ } } }, - "/subscription-interval/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Detailed information about a Subscription Interval 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": "getSubscriptionInterval", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -33379,7 +33404,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33391,7 +33416,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33406,7 +33431,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33423,16 +33448,17 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Delete a Subscription Interval 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": "deleteSubscriptionInterval", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -33463,16 +33489,17 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Partially update information about a Subscription Interval 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": "updateSubscriptionInterval", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -33490,18 +33517,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33513,7 +33540,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33528,7 +33555,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33547,14 +33574,15 @@ } } }, - "/aggregate/subscription-interval": { + "/aggregate/sso-provider-customer": { "post": { "tags": [ - "Subscription Interval" + "Sso Provider Customer", + "Experimental" ], - "summary": "Aggregate for the Subscription Interval resources.", + "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": "aggregateSubscriptionInterval", + "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -33578,7 +33606,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33592,7 +33620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33610,7 +33638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33627,14 +33655,14 @@ } } }, - "/subscription-plan": { + "/subscription": { "get": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "List with basic information of Subscription Plan resources.", + "summary": "List with basic information of Subscription resources.", "description": "", - "operationId": "getSubscriptionPlanList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -33663,7 +33691,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33682,7 +33710,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } ] @@ -33696,16 +33724,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -33726,7 +33754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33741,11 +33769,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Create a new Subscription Plan resources.", + "summary": "Create a new Subscription resources.", "description": "", - "operationId": "createSubscriptionPlan", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -33764,14 +33792,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33783,7 +33811,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33798,7 +33826,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33814,14 +33842,14 @@ } } }, - "/search/subscription-plan": { + "/search/subscription": { "post": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Search for the Subscription Plan resources.", + "summary": "Search for the Subscription resources.", "description": "", - "operationId": "searchSubscriptionPlan", + "operationId": "searchSubscription", "parameters": [ { "name": "sw-include-search-info", @@ -33849,7 +33877,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33863,7 +33891,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33881,7 +33909,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33898,19 +33926,19 @@ } } }, - "/subscription-plan/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Detailed information about a Subscription Plan resource.", + "summary": "Detailed information about a Subscription resource.", "description": "", - "operationId": "getSubscriptionPlan", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -33920,7 +33948,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33932,7 +33960,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33947,7 +33975,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -33964,16 +33992,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Delete a Subscription Plan resource.", + "summary": "Delete a Subscription resource.", "description": "", - "operationId": "deleteSubscriptionPlan", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -34004,16 +34032,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Partially update information about a Subscription Plan resource.", + "summary": "Partially update information about a Subscription resource.", "description": "", - "operationId": "updateSubscriptionPlan", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -34031,18 +34059,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Subscription resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -34054,7 +34082,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -34069,7 +34097,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -34088,14 +34116,14 @@ } } }, - "/aggregate/subscription-plan": { + "/aggregate/subscription": { "post": { "tags": [ - "Subscription Plan" + "Subscription" ], - "summary": "Aggregate for the Subscription Plan resources.", + "summary": "Aggregate for the Subscription resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionPlan", + "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { @@ -34119,7 +34147,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -34133,7 +34161,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -34151,7 +34179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Subscription" } } } @@ -34168,14 +34196,14 @@ } } }, - "/swag-delay-action": { + "/subscription-address": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "List with basic information of Swag Delay Action resources.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSwagDelayActionList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -34204,7 +34232,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34223,7 +34251,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -34237,16 +34265,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -34267,7 +34295,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34282,11 +34310,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Create a new Swag Delay Action resources.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSwagDelayAction", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -34305,14 +34333,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34324,7 +34352,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34339,7 +34367,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34355,14 +34383,14 @@ } } }, - "/search/swag-delay-action": { + "/search/subscription-address": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Search for the Swag Delay Action resources.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSwagDelayAction", + "operationId": "searchSubscriptionAddress", "parameters": [ { "name": "sw-include-search-info", @@ -34390,7 +34418,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34404,7 +34432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34422,7 +34450,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34439,19 +34467,19 @@ } } }, - "/swag-delay-action/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Detailed information about a Swag Delay Action resource.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSwagDelayAction", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -34461,7 +34489,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34473,7 +34501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34488,7 +34516,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34505,16 +34533,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Delete a Swag Delay Action resource.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSwagDelayAction", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -34545,16 +34573,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Partially update information about a Swag Delay Action resource.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSwagDelayAction", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -34572,18 +34600,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Subscription Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34595,7 +34623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34610,7 +34638,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34629,14 +34657,14 @@ } } }, - "/aggregate/swag-delay-action": { + "/aggregate/subscription-address": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Address" ], - "summary": "Aggregate for the Swag Delay Action resources.", + "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagDelayAction", + "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -34660,7 +34688,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34674,7 +34702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34692,7 +34720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34709,14 +34737,14 @@ } } }, - "/warehouse": { + "/subscription-customer": { "get": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "List with basic information of Warehouse resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getWarehouseList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -34745,7 +34773,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34764,7 +34792,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -34778,16 +34806,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/warehouse?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/warehouse?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/warehouse?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -34808,7 +34836,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34823,11 +34851,11 @@ }, "post": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Create a new Warehouse resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createWarehouse", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -34846,14 +34874,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34865,7 +34893,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34880,7 +34908,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34896,14 +34924,14 @@ } } }, - "/search/warehouse": { + "/search/subscription-customer": { "post": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Search for the Warehouse resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchWarehouse", + "operationId": "searchSubscriptionCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -34931,7 +34959,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34945,7 +34973,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34963,7 +34991,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34980,19 +35008,19 @@ } } }, - "/warehouse/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Detailed information about a Warehouse resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getWarehouse", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -35002,7 +35030,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35014,7 +35042,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35029,7 +35057,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35046,16 +35074,16 @@ }, "delete": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Delete a Warehouse resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteWarehouse", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -35086,16 +35114,16 @@ }, "patch": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Partially update information about a Warehouse resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateWarehouse", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -35113,18 +35141,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "description": "Partially update information about a Subscription Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35136,7 +35164,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35151,7 +35179,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35170,14 +35198,14 @@ } } }, - "/aggregate/warehouse": { + "/aggregate/subscription-customer": { "post": { "tags": [ - "Warehouse" + "Subscription Customer" ], - "summary": "Aggregate for the Warehouse resources.", + "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouse", + "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -35201,7 +35229,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35215,7 +35243,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35233,7 +35261,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -35250,14 +35278,14 @@ } } }, - "/warehouse-group": { + "/subscription-interval": { "get": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "List with basic information of Warehouse Group resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getWarehouseGroupList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -35286,7 +35314,7 @@ ], "responses": { "200": { - "description": "List of Warehouse Group resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35305,7 +35333,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -35319,16 +35347,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse-group?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/warehouse-group?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/warehouse-group?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/warehouse-group?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -35349,7 +35377,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35364,11 +35392,11 @@ }, "post": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Create a new Warehouse Group resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createWarehouseGroup", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -35387,14 +35415,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35406,7 +35434,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35421,7 +35449,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35437,14 +35465,14 @@ } } }, - "/search/warehouse-group": { + "/search/subscription-interval": { "post": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Search for the Warehouse Group resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchWarehouseGroup", + "operationId": "searchSubscriptionInterval", "parameters": [ { "name": "sw-include-search-info", @@ -35472,7 +35500,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35486,7 +35514,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35504,7 +35532,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35521,19 +35549,19 @@ } } }, - "/warehouse-group/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Detailed information about a Warehouse Group resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getWarehouseGroup", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -35543,7 +35571,7 @@ ], "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35555,7 +35583,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35570,7 +35598,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35587,16 +35615,16 @@ }, "delete": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Delete a Warehouse Group resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteWarehouseGroup", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -35627,16 +35655,16 @@ }, "patch": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Partially update information about a Warehouse Group resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateWarehouseGroup", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -35654,18 +35682,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "description": "Partially update information about a Subscription Interval resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35677,7 +35705,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35692,7 +35720,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35711,14 +35739,14 @@ } } }, - "/aggregate/warehouse-group": { + "/aggregate/subscription-interval": { "post": { "tags": [ - "Warehouse Group" + "Subscription Interval" ], - "summary": "Aggregate for the Warehouse Group resources.", + "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouseGroup", + "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -35742,7 +35770,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35756,7 +35784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35774,7 +35802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35791,412 +35819,290 @@ } } }, - "/_action/user/logout": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Logout the current user", - "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", - "operationId": "userLogout", - "responses": { - "204": { - "description": "Tokens have been revoked successfully." - }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." - }, - "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - }, - "/app-system/shop/verify": { + "/subscription-plan": { "get": { "tags": [ - "App System", - "Public" + "Subscription Plan" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "List with basic information of Subscription Plan resources.", + "description": "", + "operationId": "getSubscriptionPlanList", "parameters": [ { - "name": "runId", + "name": "limit", "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "token", + "name": "page", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { - "204": { - "description": "An empty response signalling successful verification." - }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_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": [ + "200": { + "description": "List of Subscription Plan resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ { - "$ref": "#/components/schemas/CustomPricingUpsertOperation" + "$ref": "#/components/schemas/success" }, { - "$ref": "#/components/schemas/CustomPricingDeleteOperation" + "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" + } + } + } + ] + } + } } ] } - } - } - } - }, - "responses": { - "200": { - "description": "Returns a JSON result containing information about the updated entities", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPricingResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionPlan" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/api/_admin/rule-builder-preview/{orderId}": { + }, "post": { "tags": [ - "Rule Preview" + "Subscription Plan" ], - "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 Subscription Plan resources.", + "description": "", + "operationId": "createSubscriptionPlan", "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/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Returns the results of the evaluated rule conditions as an object.", + "description": "Detail of SubscriptionPlan", "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/SubscriptionPlan" + } + } + } + ] } - } - } - } - } - } - }, - "/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" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" } - ] - }, - "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:
" - } - } + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/invite-employee": { + "/search/subscription-plan": { "post": { "tags": [ - "B2B Employee Management" + "Subscription Plan" ], - "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 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" } } - }, - "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 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": { - "description": "Array of the created employee ids", "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/SubscriptionPlan" } } } } } } + }, + "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": { + "/subscription-plan/{id}": { + "get": { "tags": [ - "B2B Quote Management" + "Subscription Plan" ], - "summary": "Create a new quote", - "description": "This route is used to create a new quote from admin", - "operationId": "createQuoteFromAdmin", + "summary": "Detailed information about a Subscription Plan resource.", + "description": "", + "operationId": "getSubscriptionPlan", "parameters": [ { - "name": "salesChannelId", + "name": "id", "in": "path", - "description": "Identifier of the sales channel to be fetched", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -36204,250 +36110,184 @@ } } ], - "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 SubscriptionPlan", "content": { - "application/json": { + "application/vnd.api+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" + "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" + } } - }, - "type": "object" + } } } - } - }, - "responses": { - "204": { - "description": "No content response" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/quote/{quoteId}/lineItem": { - "post": { + }, + "delete": { "tags": [ - "B2B Quote Management" + "Subscription Plan" ], - "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", + "summary": "Delete a Subscription Plan resource.", + "description": "", + "operationId": "deleteSubscriptionPlan", "parameters": [ { - "name": "quoteId", + "name": "id", "in": "path", - "description": "Identifier of the quote to be fetched", + "description": "Identifier for the subscription_plan", "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, + "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" } } ], "responses": { "204": { - "description": "No content response" + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/quote/{quoteId}/comment": { - "post": { + }, + "patch": { "tags": [ - "B2B Quote Management" + "Subscription Plan" ], - "summary": "Create a new comment", - "description": "This route is used to create a new comment from admin", - "operationId": "createComment", + "summary": "Partially update information about a Subscription Plan resource.", + "description": "", + "operationId": "updateSubscriptionPlan", "parameters": [ { - "name": "quoteId", + "name": "id", "in": "path", - "description": "Identifier of the quote to be fetched", + "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": { - "required": true, + "description": "Partially update information about a Subscription Plan resource.", "content": { "application/json": { "schema": { - "properties": { - "comment": { - "description": "Message content", - "type": "string" - }, - "state": { - "description": "Current quote state", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { - "204": { - "description": "No content response" + "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" } } } }, - "/_action/text-to-image/generate": { + "/aggregate/subscription-plan": { "post": { "tags": [ - "Text to Image" + "Subscription Plan" ], - "summary": "Generate images based on a textual prompt", - "description": "Generate images based on a textual prompt", - "operationId": "textToImageGenerate", + "summary": "Aggregate for the Subscription Plan resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -36455,1081 +36295,3863 @@ "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 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": "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==" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionPlan" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/share-config/download/{entity}/{id}": { + "/swag-delay-action": { "get": { "tags": [ - "Admin API", - "Sharing", - "Download" + "Swag Delay Action" ], - "summary": "Download a shared config", - "description": "This route is used to download a shared config", - "operationId": "downloadSharedConfig", + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", "parameters": [ { - "name": "entity", - "in": "path", - "description": "Entity name of the shared config", - "required": true, + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string", - "enum": [ - "flow", - "rule" - ] + "type": "integer" } }, { - "name": "id", - "in": "path", - "description": "Id of the shared config", - "required": true, + "name": "page", + "in": "query", + "description": "The page to be returned", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" } } ], "responses": { "200": { - "description": "Download the shared config" - }, - "400": { - "description": "Entity is not supported. Use flow, rule" + "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" + } + } + } + } + } + } }, - "404": { - "description": "Entity with id is invalid or could not be found" + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/share-config/upload/{entity}": { + }, "post": { "tags": [ - "Admin API", - "Sharing", - "Upload" + "Swag Delay Action" ], - "summary": "Upload a shared config", - "description": "This route is used to upload a shared config", - "operationId": "uploadSharedConfig", + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", "parameters": [ { - "name": "entity", - "in": "path", - "description": "Entity name of the shared config", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ - "flow", - "rule" + "basic", + "detail" ] } } ], "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" - ] + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Upload the shared config" + "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": { - "description": "Entity is not supported. Use flow, rule" + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" + }, + "/search/swag-delay-action": { + "post": { + "tags": [ + "Swag Delay Action" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" + "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" + } + } + } + } + ] + } }, - { - "$ref": "#/components/schemas/pagination" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } } - ] + } }, - "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" + } + } + }, + "/swag-delay-action/{id}": { + "get": { + "tags": [ + "Swag Delay Action" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + "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}$" + } } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "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" + } + } + } + } + } }, - "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": [ + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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" + "responses": { + "204": { + "$ref": "#/components/responses/204" }, - "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" - } - ] + "404": { + "$ref": "#/components/responses/404" }, - "related": { - "$ref": "#/components/schemas/link" + "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": [ + "patch": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", + "parameters": [ { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "name": "_response", + "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" } } } - ] - }, - "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" + }, + "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" + } + } + } + ] + } }, - "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/SwagDelayAction" + } } - ] + } } } - } - ], - "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" + "400": { + "$ref": "#/components/responses/400" }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "404": { + "$ref": "#/components/responses/404" }, - "meta": { - "$ref": "#/components/schemas/meta" + "401": { + "$ref": "#/components/responses/401" } - }, - "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" + } + } + }, + "/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" + ] + } + } } }, - "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 SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + ] + } }, - "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/SwagDelayAction" + } + } + } + } } } }, - "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": [ + } + } + }, + "/warehouse": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", + "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": { - "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" + "name": "page", + "in": "query", + "description": "The 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" }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } } - } - } - } - }, - "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": "/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" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } } - }, - "type": "object" + } } - }, - "type": "object" + } + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } }, - "AclRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" + "post": { + "tags": [ + "Warehouse" ], - "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" + "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" + ] } - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } } } }, - "type": "object" - }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "userId", - "aclRoleId" - ], - "properties": { - "id": { - "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" + } + } + } + } + } }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "400": { + "$ref": "#/components/responses/400" }, - "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" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AdvancedSearchActionJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, + } + } + }, + "/search/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Search for the Warehouse resources.", + "description": "", + "operationId": "searchWarehouse", + "parameters": [ { - "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" - } - } - } - } + "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" - }, - "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", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } } - }, - "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" + "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": [ { - "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" - } - } - } + "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" - }, - "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", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" } } - }, - "type": "object" + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } } - }, - "type": "object" + } } - }, - "type": "object" + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } }, - "AdvancedSearchActionSearchTerm": { - "required": [ - "id", - "term", - "salesChannelId", - "actionId" + "delete": { + "tags": [ + "Warehouse" ], - "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 + "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}$" + } }, - "updatedAt": { - "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" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "404": { + "$ref": "#/components/responses/404" }, - "action": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" + } }, - "AdvancedSearchBoostingJsonApi": { - "allOf": [ + "patch": { + "tags": [ + "Warehouse" + ], + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "required": [ + "name": "_response", + "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", @@ -42127,8 +44749,7 @@ "type": "string" }, "lastRenews": { - "type": "string", - "readOnly": true + "type": "string" }, "nextRenews": { "type": "string", @@ -42421,8 +45042,7 @@ "type": "string" }, "lastRenews": { - "type": "string", - "readOnly": true + "type": "string" }, "nextRenews": { "type": "string", @@ -43644,6 +46264,40 @@ "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" @@ -43713,6 +46367,9 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" @@ -48222,7 +50879,7 @@ }, "type": "object" }, - "CategoryJsonApi": { + "ProductJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -48231,6 +50888,10 @@ { "required": [ "id", + "taxId", + "price", + "productNumber", + "stock", "name" ], "properties": { @@ -48250,140 +50911,323 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", + "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "afterCategoryVersionId": { + "productManufacturerVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "description": "Unique identity of media added to identify category.", + "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "breadcrumb": { + "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}$" + }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { "type": "array", "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true + "$ref": "#/components/schemas/Price" + } }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "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 }, - "path": { - "description": "A relative URL to the category.", - "type": "string", + "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 }, - "childCount": { + "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 }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "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", - "enum": [ - "page", - "link", - "folder" - ] + "readOnly": true }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" + "ean": { + "description": "Indicates EAN of the product.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" + "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" }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, - "name": { - "type": "string" + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" }, - "customFields": { - "type": "object" + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" }, - "slotConfig": { - "type": "object" + "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" }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" }, - "internalLink": { + "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" }, - "externalLink": { - "type": "string" + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true }, - "linkNewTab": { + "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" }, - "metaDescription": { + "packUnit": { "type": "string" }, - "keywords": { + "packUnitPlural": { "type": "string" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "slotConfig": { + "type": "object" }, - "productStreamId": { - "description": "Unique identity of product stream.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "customEntityTypeId": { + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "physical", + "digital" + ] }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, "deprecated": true }, "createdAt": { @@ -48401,10 +51245,162 @@ }, "extensions": { "properties": { - "search": { + "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" }, - "advancedProductCatalogs": { + "reviewSummaries": { "properties": { "links": { "type": "object", @@ -48412,7 +51408,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, @@ -48423,11 +51419,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "product_review_summary" }, "id": { "type": "string", - "example": "fbec40add5492465d78b550a9a4ae26e" + "example": "c9c718522e64ffa5effb26cef94f4849" } } } @@ -48435,7 +51431,10 @@ }, "type": "object" }, - "advancedProductCatalogsCategories": { + "search": { + "type": "object" + }, + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -48443,7 +51442,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } } }, @@ -48454,25 +51453,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs_category" + "example": "quote_line_item" }, "id": { "type": "string", - "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of category.", + }, + "shoppingListLineItems": { "properties": { "links": { "type": "object", @@ -48480,29 +51473,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } } } } }, "type": "object" }, - "children": { - "description": "Child categories within this category for hierarchical navigation", + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", "properties": { "links": { "type": "object", @@ -48510,7 +51505,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" } } }, @@ -48521,11 +51516,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "bundle_item" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "d7706d2e11bc4878ffb242403ea5b274" } } } @@ -48533,8 +51528,8 @@ }, "type": "object" }, - "media": { - "description": "Category image or banner", + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", "properties": { "links": { "type": "object", @@ -48542,28 +51537,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" } } }, "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": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } } } } }, "type": "object" }, - "products": { + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", "properties": { "links": { "type": "object", @@ -48571,7 +51569,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" } } }, @@ -48582,19 +51580,21 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "sales_channel" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" } } } } }, - "type": "object" + "type": "object", + "readOnly": true }, - "nestedProducts": { + "items": { + "description": "Products referenced as bundle items of this bundle.", "properties": { "links": { "type": "object", @@ -48602,7 +51602,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + "example": "/product/deb10517653c255364175796ace3553f/items" } } }, @@ -48617,7 +51617,7 @@ }, "id": { "type": "string", - "example": "cf73cebf9ade7f94deba94ec71e66e43" + "example": "691d502cfd0e0626cd3b058e5682ad1c" } } } @@ -48625,8 +51625,8 @@ }, "type": "object" }, - "tags": { - "description": "Tags for organizing and filtering categories", + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", "properties": { "links": { "type": "object", @@ -48634,7 +51634,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" } } }, @@ -48645,11 +51645,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "bundle_item" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" } } } @@ -48657,8 +51657,8 @@ }, "type": "object" }, - "cmsPage": { - "description": "CMS page layout for the category", + "bundles": { + "description": "Bundles that include this product as an item.", "properties": { "links": { "type": "object", @@ -48666,28 +51666,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" + "example": "/product/deb10517653c255364175796ace3553f/bundles" } } }, "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": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" + } } } } }, "type": "object" }, - "productStream": { + "employeeWishlists": { "properties": { "links": { "type": "object", @@ -48695,28 +51697,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" + "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": "product_stream" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "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" }, - "navigationSalesChannels": { + "individualPricings": { "properties": { "links": { "type": "object", @@ -48724,7 +51759,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" } } }, @@ -48735,19 +51770,25 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "04db458d860e0a4b455ae14b384a5e8a" + "example": "5246e417af07e49dc4961c49d4ad6c75" } } } } }, "type": "object" - }, - "footerSalesChannels": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -48755,7 +51796,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" + "example": "/product/deb10517653c255364175796ace3553f/downloads" } } }, @@ -48766,11 +51807,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "product_download" }, "id": { "type": "string", - "example": "57944aba1f6dea7ca9dacf66776e1755" + "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } @@ -48778,7 +51819,8 @@ }, "type": "object" }, - "serviceSalesChannels": { + "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -48786,7 +51828,37 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" + "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": { + "description": "Product variants that inherit from this parent product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/children" } } }, @@ -48797,11 +51869,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "product" }, "id": { "type": "string", - "example": "1a79932fadba3b20baf6369181e45602" + "example": "268184c12df027f536154d099d497b31" } } } @@ -48809,7 +51881,8 @@ }, "type": "object" }, - "mainCategories": { + "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -48817,7 +51890,275 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" + "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": { + "description": "Tax configuration (rate and calculation rules)", + "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": { + "description": "Product manufacturer or brand information", + "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": { + "description": "Product unit of measure (e.g., piece, liter, kg)", + "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": { + "description": "Main product image displayed in listings and detail pages", + "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" + }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, + "featureSet": { + "properties": { + "links": { + "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": { + "description": "Custom CMS page layout for the product detail page", + "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": { + "description": "Canonical product reference for variant consolidation and SEO purposes", + "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" } } }, @@ -48828,11 +52169,11 @@ "properties": { "type": { "type": "string", - "example": "main_category" + "example": "product_price" }, "id": { "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -48840,8 +52181,8 @@ }, "type": "object" }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", + "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -48849,7 +52190,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" + "example": "/product/deb10517653c255364175796ace3553f/media" } } }, @@ -48860,489 +52201,20 @@ "properties": { "type": { "type": "string", - "example": "seo_url" + "example": "product_media" }, "id": { "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "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": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "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}$" - }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "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", - "description": "Unique identity of category." - }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Category image or banner" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "nestedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "tags": { - "description": "Tags for organizing and filtering categories", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the category" - }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" - }, - "navigationSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "footerSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "serviceSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - } - }, - "type": "object" - }, - "CategoryTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "categoryId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "category": { - "$ref": "#/components/schemas/Category" - }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "CmsBlockJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "position", - "type", - "sectionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" - }, - "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" }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "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": { + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -49350,28 +52222,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_section" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "73d5342eba070f636ac3246f319bf77f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "example": "89936e14544d1b403cecef938101b6b0" + } } } } }, "type": "object" }, - "backgroundMedia": { + "crossSellingAssignedProducts": { "properties": { "links": { "type": "object", @@ -49379,28 +52253,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling_assigned_products" + }, + "id": { + "type": "string", + "example": "5ee26b69e515f51ece26912961283b6d" + } } } } }, "type": "object" }, - "slots": { + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -49408,7 +52285,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" + "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" } } }, @@ -49419,218 +52296,19 @@ "properties": { "type": { "type": "string", - "example": "cms_slot" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "a8b72798beb911ae98c8c8907d45950a" + "example": "c0827fee13725d41f1fd7e292243f5aa" } } } } }, "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}$" - }, - "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" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "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 - }, - "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": { - "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" - }, - "relationships": { - "properties": { - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", + }, + "visibilities": { "properties": { "links": { "type": "object", @@ -49638,7 +52316,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + "example": "/product/deb10517653c255364175796ace3553f/visibilities" } } }, @@ -49649,11 +52327,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "product_visibility" }, "id": { "type": "string", - "example": "ff4dee88db82e98f0e0d524d965b9aa7" + "example": "63226fcdfe3316ec1237ef07a8fe6732" } } } @@ -49661,8 +52339,7 @@ }, "type": "object" }, - "previewMedia": { - "description": "Preview image for the CMS page in admin panel and page selection", + "searchKeywords": { "properties": { "links": { "type": "object", @@ -49670,28 +52347,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" + "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a7a817fb0e422cff87e878b8ff7ca914" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "effbcffaacb8111b531f15e6f4c796d1" + } } } } }, "type": "object" }, - "categories": { + "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -49699,7 +52379,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" + "example": "/product/deb10517653c255364175796ace3553f/productReviews" } } }, @@ -49710,11 +52390,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "product_review" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "01e78541ea343ed72424a5222796a4cd" } } } @@ -49722,8 +52402,8 @@ }, "type": "object" }, - "landingPages": { - "description": "Landing pages using this CMS layout", + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -49731,7 +52411,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + "example": "/product/deb10517653c255364175796ace3553f/mainCategories" } } }, @@ -49742,11 +52422,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "main_category" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -49754,7 +52434,8 @@ }, "type": "object" }, - "homeSalesChannels": { + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -49762,7 +52443,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" + "example": "/product/deb10517653c255364175796ace3553f/seoUrls" } } }, @@ -49773,11 +52454,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "seo_url" }, "id": { "type": "string", - "example": "9aed0c38161f67f2d40a4a872cae045f" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } @@ -49785,7 +52466,7 @@ }, "type": "object" }, - "products": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -49793,7 +52474,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" } } }, @@ -49804,233 +52485,51 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_line_item" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "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": { - "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" - }, - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - }, - "previewMedia": { - "$ref": "#/components/schemas/Media", - "description": "Preview image for the CMS page in admin panel and page selection" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "landingPages": { - "description": "Landing pages using this CMS layout", - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - }, - "homeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - }, - "type": "object" - }, - "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 `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "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" }, - "desktop": { - "type": "boolean" + "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" }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "page": { + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -50038,28 +52537,95 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" + "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": { + "description": "Product properties and characteristics for filtering", + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "cms_page" - }, - "id": { + "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": { + "description": "Categories this product is assigned to", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "71860c77c6745379b0d44304d66b6a13" + "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" }, - "backgroundMedia": { + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -50067,28 +52633,94 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" + "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": { + "description": "Read-only category tree including all parent categories for optimized queries", + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "media" - }, - "id": { + "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": { + "description": "Tags for organizing and filtering products", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "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" }, - "blocks": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -50096,7 +52728,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, @@ -50107,11 +52739,11 @@ "properties": { "type": { "type": "string", - "example": "cms_block" + "example": "custom_field_set" }, "id": { "type": "string", - "example": "e734964953f880e5164e32827950ff92" + "example": "9b29ba872ce510f033b31364c8602760" } } } @@ -50127,13 +52759,15 @@ } ] }, - "CmsSection": { + "Product": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "position", - "type", - "pageId" + "taxId", + "price", + "productNumber", + "stock", + "name" ], "properties": { "id": { @@ -50144,258 +52778,332 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "parentId": { "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" + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", + "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", - "enum": [ - "default", - "sidebar" - ] + "pattern": "^[0-9a-f]{32}$" }, - "locked": { - "type": "boolean" + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", + "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" + "featureSetId": { + "description": "Unique identity of feature set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", + "canonicalProductVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", "type": "string", - "format": "date-time", + "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 }, - "updatedAt": { - "type": "string", - "format": "date-time", + "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 }, - "page": { - "$ref": "#/components/schemas/CmsPage" + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" + "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 }, - "blocks": { + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" + }, + "variation": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "type": "string" } - } - }, - "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}$" - }, - "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": { - "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": { + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "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" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" }, - "cmsBlockVersionId": { + "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" }, - "fieldConfig": { - "type": "object" + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true }, - "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.", + "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" }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", + "name": { "type": "string" }, - "locked": { - "type": "boolean" + "keywords": { + "type": "string" }, - "config": { - "type": "object" + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "packUnit": { + "type": "string" + }, + "packUnitPlural": { + "type": "string" }, "customFields": { "type": "object" }, - "data": { - "type": "object", - "readOnly": true + "slotConfig": { + "type": "object" }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "physical", + "digital" + ] + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true }, "createdAt": { "type": "string", @@ -50410,622 +53118,453 @@ "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" - ], + "extensions": { "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": { + "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" }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], + "subscriptionPlans": { "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } }, - "amount": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } } }, "type": "object" }, - "companyTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], + "warehouseGroups": { "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + } + } }, - "amount": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } } }, "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": { + "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" }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" + "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" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "search": { + "type": "object" }, - "translated": { + "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" }, - "extensions": { + "shoppingListLineItems": { "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" - }, - "b2bPendingOrders": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } - }, - "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" - } - } + "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": { + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", "properties": { - "states": { - "description": "States/provinces/regions within the country", + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "d7706d2e11bc4878ffb242403ea5b274" } } - }, - "type": "object" - }, - "orderAddresses": { + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" } } - }, - "type": "object" - }, - "salesChannels": { + } + } + }, + "type": "object" + }, + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" } } - }, - "type": "object" - }, - "currencyCountryRoundings": { + } + } + }, + "type": "object", + "readOnly": true + }, + "items": { + "description": "Products referenced as bundle items of this bundle.", + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/items" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" } } - }, - "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": { - "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" + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" + } + } + } + } + }, + "type": "object" }, - "currencyId": { - "type": "string" + "bundles": { + "description": "Bundles that include this product as an item.", + "properties": { + "links": { + "type": "object", + "properties": { + "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" + } + } + } + } + }, + "type": "object" }, - "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" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { + "employeeWishlists": { "properties": { "links": { "type": "object", @@ -51033,7 +53572,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" } } }, @@ -51044,11 +53583,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "e91afc4e24376c8b995cece3ce354b4e" } } } @@ -51056,7 +53595,7 @@ }, "type": "object" }, - "b2bPendingOrders": { + "individualPricingComputedCaches": { "properties": { "links": { "type": "object", @@ -51064,7 +53603,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" + "example": "/product/deb10517653c255364175796ace3553f/individualPricingComputedCaches" } } }, @@ -51075,11 +53614,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "b2b_components_individual_pricing_computed_cache" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "0208611f8e65e3ceffe9b336ea836127" } } } @@ -51087,7 +53626,7 @@ }, "type": "object" }, - "b2bPendingOrderAddresses": { + "individualPricings": { "properties": { "links": { "type": "object", @@ -51095,7 +53634,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" } } }, @@ -51106,11 +53645,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order_address" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "7c55a27217c16d4e6395eb18a7f3be2f" + "example": "5246e417af07e49dc4961c49d4ad6c75" } } } @@ -51121,54 +53660,190 @@ }, "type": "object" }, - "states": { - "description": "States/provinces/regions within the country", + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/ProductDownload" } }, - "customerAddresses": { + "parent": { + "$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/CustomerAddress" + "$ref": "#/components/schemas/Product" } }, - "orderAddresses": { + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" + }, + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" + }, + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" + }, + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" + }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, + "featureSet": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "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/OrderAddress" + "$ref": "#/components/schemas/ProductPrice" } }, - "salesChannelDefaultAssignments": { + "media": { + "description": "Product images and media gallery", "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/ProductMedia" } }, - "salesChannels": { + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/ProductCrossSelling" } }, - "taxRules": { + "crossSellingAssignedProducts": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } }, - "currencyCountryRoundings": { + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "visibilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + }, + "searchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + }, + "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" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "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" + } + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" } } }, "type": "object" }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", + "BundleDiscountJsonApi": { + "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -51176,38 +53851,345 @@ { "required": [ "id", - "countryId", - "shortCode", - "name" + "bundleId", + "type", + "value" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "description": "Version identifier of the bundle discount entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "description": "Bundle product that owns this discount configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" + }, + "active": { + "description": "Indicates if the discount is currently active.", + "type": "boolean" + }, + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" + }, + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" + }, + "currencyId": { + "description": "Currency that an absolute discount value refers to.", + "type": "string", + "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": { + "currency": { + "description": "Currency entity linked to the discount.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "rules": { + "description": "Business rules that must match for the discount to apply.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/rules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "BundleDiscount": { + "description": "Added since version: 6.7.9.0", + "required": [ + "type", + "value", + "active", + "preventCombination" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "description": "Version identifier of the bundle discount entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "description": "Bundle product that owns this discount configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" + }, + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" + }, + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" + }, + "currencyId": { + "description": "Currency that an absolute discount value refers to.", + "type": "string", + "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 + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency entity linked to the discount." + }, + "rules": { + "description": "Business rules that must match for the discount to apply.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "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}$" + }, + "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" + }, + "BundleItemJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "bundleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of the country.", + "versionId": { + "description": "Version identifier of the bundle item entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Product that is included as an item in the bundle.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "description": "Version identifier of the referenced product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "description": "Bundle product that owns this item entry.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "description": "Display order for the item inside the bundle.", "type": "integer", "format": "int64" }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "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" }, - "customFields": { - "type": "object" + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -51219,79 +54201,10 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_address" - }, - "id": { - "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrderAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/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" - }, "relationships": { "properties": { - "country": { + "product": { + "description": "Association to the product entity for this bundle item.", "properties": { "links": { "type": "object", @@ -51299,7 +54212,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/product" } } }, @@ -51308,19 +54221,20 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "customerAddresses": { + "bundle": { + "description": "Association to the parent bundle product.", "properties": { "links": { "type": "object", @@ -51328,54 +54242,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/bundle" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" - } - } - } - } - }, - "type": "object" - }, - "orderAddresses": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_address" - }, - "id": { - "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" - } + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "94377c156735b39dfa4ac607234cb87c" } } } @@ -51390,42 +54271,74 @@ } ] }, - "CountryState": { - "description": "Added since version: 6.0.0.0", + "BundleItem": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "countryId", - "shortCode", - "name" + "productId", + "quantity", + "min", + "required" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of the country.", + "versionId": { + "description": "Version identifier of the bundle item entity.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" + "productId": { + "description": "Product that is included as an item in the bundle.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productVersionId": { + "description": "Version identifier of the referenced product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "description": "Bundle product that owns this item entry.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "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" }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "showBundleOnItemPdp": { + "type": "boolean", + "description": "Show bundle on the product detail page of this bundle item." }, - "customFields": { - "type": "object" + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -51437,95 +54350,69 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "product": { + "$ref": "#/components/schemas/BundleItemProduct", + "description": "Association to the product entity for this bundle item." }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_address" - }, - "id": { - "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrderAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/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" + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association to the parent bundle product." }, - "country": { - "$ref": "#/components/schemas/Country" + "apiAlias": { + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "BundleVisibility": { + "description": "Added since version: 6.7.9.0", + "required": [ + "bundleId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } + "bundleId": { + "description": "Bundle product whose visibility is configured.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } + "productVersionId": { + "description": "Version identifier of the bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Sales channel in which the bundle should be visible.", + "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", + "description": "Association to the sales channel entity." + }, + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association back to the bundle product." } }, "type": "object" }, - "CurrencyJsonApi": { + "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -51534,12 +54421,6 @@ { "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", "name" ], "properties": { @@ -51547,83 +54428,153 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" + "versionId": { + "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" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "type": "string" + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", + "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" + "format": "int64", + "readOnly": true }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" + }, + "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" }, "customFields": { "type": "object" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "slotConfig": { "type": "object" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "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}$" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true }, "createdAt": { "type": "string", @@ -51640,7 +54591,10 @@ }, "extensions": { "properties": { - "subscriptions": { + "search": { + "type": "object" + }, + "advancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -51648,7 +54602,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" } } }, @@ -51659,11 +54613,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "fbec40add5492465d78b550a9a4ae26e" } } } @@ -51671,7 +54625,7 @@ }, "type": "object" }, - "quotes": { + "advancedProductCatalogsCategories": { "properties": { "links": { "type": "object", @@ -51679,7 +54633,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" } } }, @@ -51690,19 +54644,55 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" } } } } }, "type": "object" + } + }, + "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" + } + } + } + }, + "type": "object" }, - "b2bPendingOrders": { + "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -51710,7 +54700,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" } } }, @@ -51721,11 +54711,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "category" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "268184c12df027f536154d099d497b31" } } } @@ -51733,7 +54723,8 @@ }, "type": "object" }, - "budgets": { + "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -51741,7 +54732,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + "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" } } }, @@ -51752,24 +54772,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "product" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "salesChannelDefaultAssignments": { + }, + "nestedProducts": { "properties": { "links": { "type": "object", @@ -51777,7 +54792,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" } } }, @@ -51788,11 +54803,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "product" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "cf73cebf9ade7f94deba94ec71e66e43" } } } @@ -51800,7 +54815,8 @@ }, "type": "object" }, - "orders": { + "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -51808,7 +54824,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/orders" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" } } }, @@ -51819,11 +54835,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "tag" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -51831,7 +54847,8 @@ }, "type": "object" }, - "salesChannels": { + "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -51839,7 +54856,65 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" + "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" } } }, @@ -51854,7 +54929,7 @@ }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "04db458d860e0a4b455ae14b384a5e8a" } } } @@ -51862,7 +54937,7 @@ }, "type": "object" }, - "salesChannelDomains": { + "footerSalesChannels": { "properties": { "links": { "type": "object", @@ -51870,7 +54945,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" } } }, @@ -51881,11 +54956,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "sales_channel" }, "id": { "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" + "example": "57944aba1f6dea7ca9dacf66776e1755" } } } @@ -51893,7 +54968,7 @@ }, "type": "object" }, - "promotionDiscountPrices": { + "serviceSalesChannels": { "properties": { "links": { "type": "object", @@ -51901,7 +54976,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" } } }, @@ -51912,11 +54987,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount_prices" + "example": "sales_channel" }, "id": { "type": "string", - "example": "325723473ecab76b0f45e1554513f779" + "example": "1a79932fadba3b20baf6369181e45602" } } } @@ -51924,7 +54999,7 @@ }, "type": "object" }, - "productExports": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -51932,7 +55007,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" } } }, @@ -51943,11 +55018,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "main_category" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -51955,7 +55030,8 @@ }, "type": "object" }, - "countryRoundings": { + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -51963,7 +55039,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" } } }, @@ -51974,11 +55050,11 @@ "properties": { "type": { "type": "string", - "example": "currency_country_rounding" + "example": "seo_url" }, "id": { "type": "string", - "example": "3de4aa80c8c8822ea10d156a6f58d6f7" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } @@ -51994,16 +55070,10 @@ } ] }, - "Currency": { + "Category": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", "name" ], "properties": { @@ -52011,83 +55081,153 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" + "versionId": { + "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" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "type": "string" + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", + "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" + "format": "int64", + "readOnly": true }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" + }, + "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" }, "customFields": { "type": "object" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "slotConfig": { "type": "object" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "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}$" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true }, "createdAt": { "type": "string", @@ -52104,69 +55244,10 @@ }, "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" - } - } - } - } - }, + "search": { "type": "object" }, - "b2bPendingOrders": { + "advancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -52174,7 +55255,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" } } }, @@ -52185,11 +55266,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "fbec40add5492465d78b550a9a4ae26e" } } } @@ -52197,7 +55278,7 @@ }, "type": "object" }, - "budgets": { + "advancedProductCatalogsCategories": { "properties": { "links": { "type": "object", @@ -52205,7 +55286,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" } } }, @@ -52216,11 +55297,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" } } } @@ -52231,283 +55312,115 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "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/SalesChannel" + "$ref": "#/components/schemas/Category" } }, - "orders": { + "media": { + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" + }, + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/Product" } }, - "salesChannels": { + "nestedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "navigationSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, - "salesChannelDomains": { + "footerSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } }, - "promotionDiscountPrices": { + "serviceSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/SalesChannel" } }, - "productExports": { + "mainCategories": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/MainCategory" } }, - "countryRoundings": { + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/SeoUrl" } } }, "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", + "CategoryTag": { + "description": "Added since version: 6.0.0.0", "required": [ - "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" + "categoryId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "categoryVersionId": { "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": { + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "category": { + "$ref": "#/components/schemas/Category" }, - "country": { - "$ref": "#/components/schemas/Country" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "CustomEntityJsonApi": { - "description": "Added since version: 6.4.9.0", + "CmsBlockJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -52515,184 +55428,97 @@ { "required": [ "id", - "name", - "fields" + "position", + "type", + "sectionId" ], "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.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { - "description": "Unique identity of plugin.", + "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" }, - "customFieldsAware": { - "description": "Parameter that indicates the areas in which the custom field is supported.", + "locked": { "type": "boolean" }, - "labelProperty": { - "description": "Specifies which property or attribute of the custom entity is used.", + "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, - "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}$" + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" }, - "name": { - "description": "Unique name of a custom field.", + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, - "type": { - "description": "Custom field type can be selection, media , etc", + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, - "config": { - "type": "object" + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the custom field is enabled for use.", - "type": "boolean" + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" }, - "customFieldSetId": { - "description": "Unique identity of customFieldSet.", + "backgroundMediaId": { + "description": "Unique identity of background media.", "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" + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" }, - "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" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "storeApiAware": { - "type": "boolean" + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" }, - "includeInSearch": { - "type": "boolean" + "sectionId": { + "description": "Unique identity of section.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -52704,45 +55530,38 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "advancedSearchConfigFields": { + "section": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "bdf4d1c41d2b0aa72620e925951c2b0d" - } + "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" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customFieldSet": { + }, + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -52750,7 +55569,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" } } }, @@ -52759,19 +55578,19 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, - "productSearchConfigFields": { + "slots": { "properties": { "links": { "type": "object", @@ -52779,7 +55598,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" } } }, @@ -52790,11 +55609,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_config_field" + "example": "cms_slot" }, "id": { "type": "string", - "example": "ae6a70432f71d6905502769f184399b1" + "example": "a8b72798beb911ae98c8c8907d45950a" } } } @@ -52810,51 +55629,101 @@ } ] }, - "CustomField": { + "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "type" + "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 a custom field.", + "description": "Unique name of the CMS Block.", "type": "string" }, - "type": { - "description": "Custom field type can be selection, media , etc", + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, - "config": { - "type": "object" + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the custom field is enabled for use.", - "type": "boolean" + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" }, - "customFieldSetId": { - "description": "Unique identity of customFieldSet.", + "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}$" }, - "allowCustomerWrite": { - "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", - "type": "boolean" + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" }, - "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" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "storeApiAware": { - "type": "boolean" + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" }, - "includeInSearch": { - "type": "boolean" + "sectionId": { + "description": "Unique identity of section.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -52866,55 +55735,22 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "advancedSearchConfigFields": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "bdf4d1c41d2b0aa72620e925951c2b0d" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "section": { + "$ref": "#/components/schemas/CmsSection" }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "backgroundMedia": { + "$ref": "#/components/schemas/Media" }, - "productSearchConfigFields": { + "slots": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/CmsSlot" } } }, "type": "object" }, - "CustomFieldSetJsonApi": { + "CmsPageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -52923,38 +55759,51 @@ { "required": [ "id", - "name" + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "name": { - "description": "Unique name of a custom field set.", "type": "string" }, - "config": { - "type": "object" + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", - "type": "boolean" + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" }, - "appId": { - "description": "Unique identity of an app.", + "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", @@ -52965,9 +55814,13 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "customFields": { + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -52975,7 +55828,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" } } }, @@ -52986,11 +55839,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "cms_section" }, "id": { "type": "string", - "example": "4e252ff73243c27b4df9002e452fc6a7" + "example": "ff4dee88db82e98f0e0d524d965b9aa7" } } } @@ -52998,7 +55851,8 @@ }, "type": "object" }, - "relations": { + "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -53006,7 +55860,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + "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" } } }, @@ -53017,11 +55900,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set_relation" + "example": "category" }, "id": { "type": "string", - "example": "06c5b10273a69992d8c6933e294909fa" + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } @@ -53029,7 +55912,8 @@ }, "type": "object" }, - "products": { + "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -53037,7 +55921,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" } } }, @@ -53048,11 +55932,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "landing_page" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } @@ -53060,7 +55944,7 @@ }, "type": "object" }, - "app": { + "homeSalesChannels": { "properties": { "links": { "type": "object", @@ -53068,21 +55952,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "9aed0c38161f67f2d40a4a872cae045f" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } @@ -53097,42 +56014,55 @@ } ] }, - "CustomFieldSet": { + "CmsPage": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name" + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "name": { - "description": "Unique name of a custom field set.", "type": "string" }, - "config": { - "type": "object" + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", - "type": "boolean" + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" }, - "appId": { - "description": "Unique identity of an app.", + "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", @@ -53143,16 +56073,37 @@ "format": "date-time", "readOnly": true }, - "customFields": { + "translated": { + "type": "object" + }, + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CmsSection" } }, - "relations": { + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" + }, + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$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": { @@ -53160,14 +56111,11 @@ "items": { "$ref": "#/components/schemas/Product" } - }, - "app": { - "$ref": "#/components/schemas/App" } }, "type": "object" }, - "CustomFieldSetRelationJsonApi": { + "CmsSectionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -53176,23 +56124,90 @@ { "required": [ "id", - "customFieldSetId", - "entityName" + "position", + "type", + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { - "description": "Name of the entity.", + "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 `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] + }, + "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" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -53205,7 +56220,36 @@ }, "relationships": { "properties": { - "customFieldSet": { + "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", @@ -53213,7 +56257,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, @@ -53222,12 +56266,43 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "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" + } } } } @@ -53242,27 +56317,94 @@ } ] }, - "CustomFieldSetRelation": { + "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "customFieldSetId", - "entityName" + "position", + "type", + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { - "description": "Name of the entity.", + "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 `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] + }, + "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" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -53273,13 +56415,23 @@ "format": "date-time", "readOnly": true }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "page": { + "$ref": "#/components/schemas/CmsPage" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } } }, "type": "object" }, - "CustomPriceJsonApi": { + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -53287,33 +56439,52 @@ { "required": [ "id", - "productId", - "price" + "type", + "slot", + "blockId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "fieldConfig": { + "type": "object" }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" }, - "price": { + "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", @@ -53324,67 +56495,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" - } - } - } - }, - "type": "object" - }, - "product": { + "block": { "properties": { "links": { "type": "object", @@ -53392,7 +56508,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, @@ -53401,12 +56517,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "14511f2f5564650d129ca7cabc333278" } } } @@ -53421,36 +56537,56 @@ } ] }, - "CustomPrice": { + "CmsSlot": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "price" + "type", + "slot", + "blockId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "fieldConfig": { + "type": "object" }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" }, - "price": { + "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", @@ -53461,19 +56597,16 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "translated": { + "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "block": { + "$ref": "#/components/schemas/CmsBlock" } }, "type": "object" }, - "CustomerJsonApi": { + "CountryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -53482,185 +56615,126 @@ { "required": [ "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" + "name", + "addressFormat" ], "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.", + "name": { "type": "string" }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "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": "To keep the status of the customer active, the boolean value is set to `true`.", + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, - "doubleOptInRegistration": { - "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent.", - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed.", - "type": "string", - "format": "date-time" - }, - "hash": { - "description": "Customer registration double opt-in hash for confirming the customer account.", + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "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 + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", - "readOnly": true + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", - "readOnly": true + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", - "readOnly": true + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } }, - "readOnly": true + "type": "object" }, - "requestedGroupId": { - "description": "Unique identity of requested group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" }, - "boundSalesChannelId": { - "description": "Unique identity of bonus sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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", @@ -53672,9 +56746,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "customPrice": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -53682,7 +56759,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, @@ -53693,11 +56770,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "subscription_address" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -53705,7 +56782,7 @@ }, "type": "object" }, - "subscriptionCustomers": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -53713,7 +56790,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, @@ -53724,11 +56801,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_customer" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -53736,7 +56813,7 @@ }, "type": "object" }, - "delayActions": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -53744,7 +56821,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, @@ -53755,19 +56832,25 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" - }, - "employees": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -53775,7 +56858,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, @@ -53786,11 +56869,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "country_state" }, "id": { "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } @@ -53798,7 +56881,7 @@ }, "type": "object" }, - "roles": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -53806,7 +56889,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, @@ -53817,11 +56900,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "customer_address" }, "id": { "type": "string", - "example": "4295e8065f2f640103f566df3329e17f" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -53829,7 +56912,7 @@ }, "type": "object" }, - "b2bBusinessPartner": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -53837,28 +56920,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_business_partner" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } } } } }, "type": "object" }, - "specificFeatures": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -53866,28 +56951,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_specific_features" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "ssoProviderCustomers": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -53895,7 +56982,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, @@ -53906,11 +56993,11 @@ "properties": { "type": { "type": "string", - "example": "sso_provider_customer" + "example": "sales_channel" }, "id": { "type": "string", - "example": "6f2bd941c85a0835cd1889fd0a2c835a" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -53918,7 +57005,7 @@ }, "type": "object" }, - "quotes": { + "taxRules": { "properties": { "links": { "type": "object", @@ -53926,7 +57013,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, @@ -53937,11 +57024,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "tax_rule" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "1b93ada511aac379c19d3afcba4e4041" } } } @@ -53949,7 +57036,7 @@ }, "type": "object" }, - "quoteComments": { + "currencyCountryRoundings": { "properties": { "links": { "type": "object", @@ -53957,7 +57044,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, @@ -53968,19 +57055,366 @@ "properties": { "type": { "type": "string", - "example": "quote_comment" + "example": "currency_country_rounding" }, "id": { "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" + "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": { + "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", + "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" + } + } }, - "organizationUnits": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_address" + }, + "id": { + "type": "string", + "example": "8951627da0210d39cc55d1a91ae21b8d" + } + } + } + } + }, + "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" + }, + "states": { + "description": "States/provinces/regions within the country", + "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": { + "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" + }, + "extensions": { + "properties": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -53988,7 +57422,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, @@ -53999,11 +57433,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "subscription_address" }, "id": { "type": "string", - "example": "4ab85f040b199b758bfb81e383c50b4b" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -54011,7 +57445,7 @@ }, "type": "object" }, - "b2bApprovalRules": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -54019,7 +57453,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, @@ -54030,19 +57464,24 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "545759fb10fcbebd03f04277239baace" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" - }, - "b2bPendingOrders": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "country": { "properties": { "links": { "type": "object", @@ -54050,30 +57489,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "shoppingLists": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -54081,7 +57518,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, @@ -54092,11 +57529,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list" + "example": "customer_address" }, "id": { "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -54104,7 +57541,7 @@ }, "type": "object" }, - "b2bAdvancedProductCatalogs": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -54112,7 +57549,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, @@ -54123,19 +57560,277 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "order_address" }, "id": { "type": "string", - "example": "912596af64fb66beeb84defb9535e16d" + "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": { + "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" + }, + "extensions": { + "properties": { + "subscriptionCustomerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" + } + } }, - "budgets": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_address" + }, + "id": { + "type": "string", + "example": "8951627da0210d39cc55d1a91ae21b8d" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/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" + }, + "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": { + "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" + } + }, + "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" + }, + "extensions": { + "properties": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -54143,7 +57838,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" + "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, @@ -54154,11 +57849,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "subscription" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -54166,7 +57861,7 @@ }, "type": "object" }, - "individualPricingCompanyAssignments": { + "quotes": { "properties": { "links": { "type": "object", @@ -54174,7 +57869,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" + "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, @@ -54185,174 +57880,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" + "example": "quote" }, "id": { "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" + "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" - } - }, - "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" - } - } - } - }, - "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": { - "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" - } - } - } - }, - "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" - } - } - } - }, - "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" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" - } - } - } - }, - "type": "object" }, - "activeBillingAddress": { - "description": "Currently active billing address in the session", + "bundleDiscounts": { "properties": { "links": { "type": "object", @@ -54360,29 +57900,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + "example": "/currency/386c339d37e737a436499d423a77df0c/bundleDiscounts" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1a4362407b6a71fa80952dcd4ba7feb3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } } } } }, "type": "object" }, - "defaultShippingAddress": { - "description": "Default shipping address for the customer", + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -54390,29 +57931,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } } } } }, "type": "object" }, - "activeShippingAddress": { - "description": "Currently active shipping address in the session", + "budgets": { "properties": { "links": { "type": "object", @@ -54420,29 +57962,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f6e2f5dd29b543b8547e30d2d71a6974" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } } } } }, "type": "object" - }, - "salutation": { - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -54450,29 +57998,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, "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": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "addresses": { - "description": "All addresses saved for the customer", + "orders": { "properties": { "links": { "type": "object", @@ -54480,7 +58029,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, @@ -54491,11 +58040,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "order" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -54503,7 +58052,7 @@ }, "type": "object" }, - "orderCustomers": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -54511,7 +58060,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, @@ -54522,11 +58071,11 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "sales_channel" }, "id": { "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -54534,8 +58083,7 @@ }, "type": "object" }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -54543,7 +58091,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, @@ -54554,11 +58102,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } @@ -54566,7 +58114,7 @@ }, "type": "object" }, - "promotions": { + "promotionDiscountPrices": { "properties": { "links": { "type": "object", @@ -54574,7 +58122,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" + "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" } } }, @@ -54585,11 +58133,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "promotion_discount_prices" }, "id": { "type": "string", - "example": "ea6aeb050f871384f25fba9c869cfe21" + "example": "325723473ecab76b0f45e1554513f779" } } } @@ -54597,7 +58145,7 @@ }, "type": "object" }, - "productReviews": { + "productExports": { "properties": { "links": { "type": "object", @@ -54605,7 +58153,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" + "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" } } }, @@ -54616,11 +58164,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "product_export" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -54628,7 +58176,7 @@ }, "type": "object" }, - "recoveryCustomer": { + "countryRoundings": { "properties": { "links": { "type": "object", @@ -54636,117 +58184,432 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" + "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_recovery" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ce9d8d13e51bf43bc70a4be38950823b" + "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": { + "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" + } + }, + "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" + }, + "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" + }, + "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" }, - "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" + "interval": { + "type": "number", + "format": "float" }, - "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" + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" }, - "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" + "interval": { + "type": "number", + "format": "float" }, - "createdBy": { + "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", @@ -54754,7 +58617,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, @@ -54763,19 +58626,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "updatedBy": { + "country": { "properties": { "links": { "type": "object", @@ -54783,7 +58646,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" } } }, @@ -54792,12 +58655,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } @@ -54812,189 +58675,212 @@ } ] }, - "Customer": { - "description": "Added since version: 6.0.0.0", + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "description": "Unique identity of customer group.", + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language.", - "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" }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", + "format": "date-time", "readOnly": true }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "salutationId": { - "description": "Unique identity of salutation.", + "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": { + "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" + } + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "required": [ + "id", + "name", + "fields" + ], + "properties": { + "id": { "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.", + "name": { + "description": "Unique name of the entity.", "type": "string" }, - "active": { - "description": "To keep the status of the customer active, the boolean value is set to `true`.", - "type": "boolean" + "fields": { + "type": "object" }, - "doubleOptInRegistration": { - "description": "Set to `true` to allow user subscriptions to an email marketing list.", - "type": "boolean" + "flags": { + "type": "object" }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent.", + "appId": { + "description": "Unique identity of app.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed.", + "pluginId": { + "description": "Unique identity of plugin.", "type": "string", - "format": "date-time" - }, - "hash": { - "description": "Customer registration double opt-in hash for confirming the customer account.", - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", "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 + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "customFields": { - "type": "object" + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "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": { + "deletedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, "createdAt": { "type": "string", @@ -55005,409 +58891,236 @@ "type": "string", "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "extensions": { + { + "required": [ + "id", + "name", + "type" + ], "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" - } - } - } - } - }, + "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" }, - "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" + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" }, - "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" + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "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" + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" }, - "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" + "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" }, - "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" + "storeApiAware": { + "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" + "includeInSearch": { + "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "quoteComments": { + "extensions": { "properties": { - "links": { - "type": "object", + "advancedSearchConfigFields": { "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" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" + } } - } - } - } - }, - "type": "object" - }, - "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" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" + } + } } } - } + }, + "type": "object" } }, "type": "object" }, - "b2bApprovalRules": { + "relationships": { "properties": { - "links": { - "type": "object", + "customFieldSet": { "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" + "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" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" - } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "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" - }, - "shoppingLists": { + } + }, + "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", @@ -55415,7 +59128,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" } } }, @@ -55426,206 +59139,593 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list" + "example": "advanced_search_config_field" }, "id": { "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" } } } } }, "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" }, - "b2bAdvancedProductCatalogs": { + "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": { - "links": { - "type": "object", + "customFields": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + "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" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { - "type": "string", - "example": "912596af64fb66beeb84defb9535e16d" + "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": { + "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", + "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": { + "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" }, - "budgets": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { "properties": { - "links": { - "type": "object", + "customer": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" + "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" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "customerGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "115091b01a7299f28a5ce7e1b712a222" + } } } - } - } - }, - "type": "object" - }, - "individualPricingCompanyAssignments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" - } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" - }, - "id": { - "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/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" + } + ] + }, + "CustomPrice": { + "required": [ + "id", + "productId", + "price" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "group": { - "$ref": "#/components/schemas/CustomerGroup", - "description": "Customer group determining pricing and permissions" - }, - "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" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salutation": { - "$ref": "#/components/schemas/Salutation", - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "addresses": { - "description": "All addresses saved for the customer", - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderCustomers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "price": { + "type": "object" }, - "promotions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "recoveryCustomer": { - "$ref": "#/components/schemas/CustomerRecovery" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "requestedGroup": { + "customerGroup": { "$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" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "CustomerAddressJsonApi": { + "CustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -55634,33 +59734,60 @@ { "required": [ "id", - "customerId", - "countryId", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", "firstName", "lastName", - "city", - "street" + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of customer.", + "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of country.", + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "description": "Unique identity of country's state.", + "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", @@ -55674,49 +59801,119 @@ "description": "Last name of the customer.", "type": "string" }, - "zipcode": { - "description": "Postal or zip code of customer's address.", + "email": { + "description": "Email ID of the customer.", "type": "string" }, - "city": { - "description": "Name of customer's city.", + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, - "company": { - "description": "Name of customer's company.", + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, - "street": { - "description": "Name of customer's street.", + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, - "department": { - "description": "Name of customer's department.", - "type": "string" + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" }, - "phoneNumber": { - "description": "Customer's phone number.", - "type": "string" + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", - "type": "string" + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", + "hash": { + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "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", @@ -55729,7 +59926,191 @@ }, "extensions": { "properties": { - "organizationCustomerAddresses": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, + "customPrice": { + "properties": { + "links": { + "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", + "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" + }, + "b2bBusinessPartner": { "properties": { "links": { "type": "object", @@ -55737,7 +60118,65 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" + "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" } } }, @@ -55748,11 +60187,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization_customer_address" + "example": "sso_provider_customer" }, "id": { "type": "string", - "example": "ada6a19a929bea8dbec29edb3d68df58" + "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } } @@ -55760,7 +60199,7 @@ }, "type": "object" }, - "organizationDefaultShippingAddresses": { + "quotes": { "properties": { "links": { "type": "object", @@ -55768,7 +60207,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } } }, @@ -55779,11 +60218,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "quote" }, "id": { "type": "string", - "example": "789476f40e97708274b7ff68e5dfd729" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -55791,7 +60230,7 @@ }, "type": "object" }, - "organizationDefaultBillingAddresses": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -55799,7 +60238,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } } }, @@ -55810,24 +60249,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "quote_comment" }, "id": { "type": "string", - "example": "7b0213487f5e71c973532f6f31740e5a" + "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customer": { + }, + "organizationUnits": { "properties": { "links": { "type": "object", @@ -55835,28 +60269,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" } } }, "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_organization" + }, + "id": { + "type": "string", + "example": "4ab85f040b199b758bfb81e383c50b4b" + } } } } }, "type": "object" }, - "country": { + "b2bApprovalRules": { "properties": { "links": { "type": "object", @@ -55864,28 +60300,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" } } }, "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": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "545759fb10fcbebd03f04277239baace" + } } } } }, "type": "object" }, - "countryState": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -55893,28 +60331,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" } } }, "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": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } } } } }, "type": "object" }, - "salutation": { + "shoppingLists": { "properties": { "links": { "type": "object", @@ -55922,303 +60362,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" } } }, "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": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } } } } }, "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": { - "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 - }, - "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", + "b2bAdvancedProductCatalogs": { "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" + "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" - }, - "organizationDefaultBillingAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" - } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "7b0213487f5e71c973532f6f31740e5a" + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" + } } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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" - }, - "extensions": { - "properties": { - "customPrice": { + }, + "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", @@ -56226,7 +60455,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" } } }, @@ -56237,19 +60466,25 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "b2b_components_individual_pricing_company_assignment" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "78fc5e012f88233a08401f2351a299a9" } } } } }, "type": "object" - }, - "advancedProductCatalog": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -56257,7 +60492,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" } } }, @@ -56266,24 +60501,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ff9540fcefd24264341c5a70314b71be" + "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customers": { + }, + "salesChannel": { "properties": { "links": { "type": "object", @@ -56291,30 +60521,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "salesChannels": { + "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -56322,30 +60551,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" } } }, "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": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "registrationSalesChannels": { + "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -56353,245 +60581,89 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" } } }, "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": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bb083200005a374b86f6f5fbbff6f0e0" } } } }, "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" - }, - "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" - }, - "advancedProductCatalog": { - "properties": { - "links": { - "type": "object", + "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + "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" }, - "data": { - "type": "object", + "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ff9540fcefd24264341c5a70314b71be" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } } - } - } - }, - "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": { - "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": { + }, + "type": "object" + }, + "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -56599,7 +60671,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" } } }, @@ -56608,99 +60680,50 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "8218c377171d06883caea7e2baf67f31" } } } }, "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": { - "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": { - "customer": { + }, + "activeShippingAddress": { + "description": "Currently active shipping address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, + "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -56708,7 +60731,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" } } }, @@ -56717,131 +60740,20 @@ "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": { - "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": { + }, + "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -56849,7 +60761,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" } } }, @@ -56860,11 +60772,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist_product" + "example": "customer_address" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "963e3a2fe559e393bad631f3dc686f69" } } } @@ -56872,7 +60784,7 @@ }, "type": "object" }, - "customer": { + "orderCustomers": { "properties": { "links": { "type": "object", @@ -56880,28 +60792,93 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "customer" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "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" }, - "salesChannel": { + "productReviews": { "properties": { "links": { "type": "object", @@ -56909,7 +60886,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" + "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" } } }, @@ -56918,120 +60926,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": { - "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" - } - }, - "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": { + }, + "requestedGroup": { "properties": { "links": { "type": "object", @@ -57039,7 +60946,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" } } }, @@ -57048,19 +60955,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", @@ -57068,7 +60975,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" } } }, @@ -57077,126 +60984,50 @@ "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": { - "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" - } - }, - "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": { + }, + "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", @@ -57204,30 +61035,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "products": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -57235,23 +61064,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" } } }, "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": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -57266,653 +61093,849 @@ } ] }, - "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": { - "type": "string" + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "min": { - "description": "Minimum delivery time taken.", - "type": "integer", - "format": "int64" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "max": { - "description": "Maximum delivery time taken.", + "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" + "format": "int64", + "readOnly": true }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours.", + "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, - "customFields": { - "type": "object" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "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", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Customer registration double opt-in hash for confirming the customer account.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, - "translated": { + "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" }, - "shippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, - "products": { + "tagIds": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" - } - } - }, - "type": "object" - }, - "DocumentJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - { - "required": [ - "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" - ], + "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": { - "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": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, "type": "object" }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" + "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" }, - "deepLinkCode": { - "type": "string" + "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" }, - "documentNumber": { - "type": "string" + "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" }, - "customFields": { + "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" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" }, - "relationships": { + "specificFeatures": { "properties": { - "documentType": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" } - }, - "type": "object" + } }, - "order": { + "data": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" - } - } + "type": { + "type": "string", + "example": "customer_specific_features" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } - }, - "type": "object" - }, - "referencedDocument": { + } + } + }, + "type": "object" + }, + "ssoProviderCustomers": { + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } - }, - "type": "object" - }, - "documentMediaFile": { + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } - }, - "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" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" } } - }, - "type": "object" + } } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "Document": { - "description": "Added since version: 6.0.0.0", - "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 - }, - "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": { - "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" + "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" }, - "filenameSuffix": { - "description": "A suffix name added to the file name separated by an underscore.", - "type": "string" + "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" }, - "global": { - "description": "When set to `true`, the document can be used across all sales channels.", - "type": "boolean" + "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" }, - "documentNumber": { - "description": "Unique number associated with every document.", - "type": "string" + "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" }, - "config": { + "shoppingLists": { + "properties": { + "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" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { + "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" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { + "budgets": { "properties": { - "documentType": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" } - }, - "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" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" } } - }, - "type": "object" - }, - "salesChannels": { + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "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" + } } }, "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": { - "description": "Unique identity of the document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, - "logoId": { - "description": "Unique identity of the company logo.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "name": { - "description": "Name of the document.", - "type": "string" + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, - "filenamePrefix": { - "description": "A prefix name added to the file name separated by an underscore.", - "type": "string" + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, - "filenameSuffix": { - "description": "A suffix name added to the file name separated by an underscore.", - "type": "string" + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, - "global": { - "description": "When set to `true`, the document can be used across all sales channels.", - "type": "boolean" + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, - "documentNumber": { - "description": "Unique number associated with every document.", - "type": "string" + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, - "config": { - "type": "object" + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, - "customFields": { - "type": "object" + "addresses": { + "description": "All addresses saved for the customer", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "logo": { - "$ref": "#/components/schemas/Media", - "description": "Logo in the document at the top-right corner." + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "salesChannels": { + "productReviews": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$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" } }, "type": "object" }, - "DocumentBaseConfigSalesChannelJsonApi": { + "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -57921,207 +61944,89 @@ { "required": [ "id", - "documentBaseConfigId" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "description": "Unique identity of document type.", + "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "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": { - "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" - } - }, - "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}$" + "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" }, - "name": { + "company": { + "description": "Name of customer's company.", "type": "string" }, - "technicalName": { - "description": "Technical name of document type.", + "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", @@ -58132,15 +62037,9 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "quoteDocuments": { + "organizationCustomerAddresses": { "properties": { "links": { "type": "object", @@ -58148,7 +62047,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, @@ -58159,24 +62058,19 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "ada6a19a929bea8dbec29edb3d68df58" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "documents": { + }, + "organizationDefaultShippingAddresses": { "properties": { "links": { "type": "object", @@ -58184,7 +62078,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" } } }, @@ -58195,11 +62089,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "789476f40e97708274b7ff68e5dfd729" } } } @@ -58207,7 +62101,7 @@ }, "type": "object" }, - "documentBaseConfigs": { + "organizationDefaultBillingAddresses": { "properties": { "links": { "type": "object", @@ -58215,7 +62109,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" } } }, @@ -58226,19 +62120,24 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + "example": "7b0213487f5e71c973532f6f31740e5a" } } } } }, "type": "object" - }, - "documentBaseConfigSalesChannels": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customer": { "properties": { "links": { "type": "object", @@ -58246,193 +62145,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } }, "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": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "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": { - "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": { - "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": { - "$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": { + "country": { "properties": { "links": { "type": "object", @@ -58440,35 +62174,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, "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": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "sequences": { + }, + "countryState": { "properties": { "links": { "type": "object", @@ -58476,30 +62203,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "eb6710ddc89dae357ae94ca3974b1e38" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "appFlowEvent": { + "salutation": { "properties": { "links": { "type": "object", @@ -58507,7 +62232,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" } } }, @@ -58516,12 +62241,12 @@ "properties": { "type": { "type": "string", - "example": "app_flow_event" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d92d404135abc21e31337d9509cbe62f" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -58536,52 +62261,93 @@ } ] }, - "Flow": { - "description": "Added since version: 6.4.6.0", + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "eventName" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the flow.", + "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" }, - "eventName": { - "description": "Name of the event.", + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "priority": { - "description": "A numerical value to prioritize one of the flows from the list.", - "type": "integer", - "format": "int64" + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" }, - "invalid": { - "description": "When the boolean value is `true`, the flow is no more available for usage.", - "type": "boolean", - "readOnly": true + "city": { + "description": "Name of customer's city.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the flow is available for selection.", - "type": "boolean" + "company": { + "description": "Name of customer's company.", + "type": "string" }, - "description": { - "description": "A short description of the defined flow.", + "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" }, - "appFlowEventId": { - "description": "Unique identity of app flow event.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -58594,7 +62360,7 @@ }, "extensions": { "properties": { - "delayActions": { + "organizationCustomerAddresses": { "properties": { "links": { "type": "object", @@ -58602,7 +62368,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, @@ -58613,11 +62379,73 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "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" } } } @@ -58628,20 +62456,23 @@ }, "type": "object" }, - "sequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } + "customer": { + "$ref": "#/components/schemas/Customer" }, - "appFlowEvent": { - "$ref": "#/components/schemas/AppFlowEvent" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "FlowSequenceJsonApi": { - "description": "Added since version: 6.4.6.0", + "CustomerGroupJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -58649,53 +62480,38 @@ { "required": [ "id", - "flowId" + "name" ], "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.", + "name": { "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" + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" }, - "displayGroup": { - "description": "The group to which the flow sequence is visible.", - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, - "trueCase": { + "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationTitle": { + "type": "string" }, - "customFields": { - "type": "object" + "registrationIntroduction": { + "type": "string" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" }, "createdAt": { "type": "string", @@ -58707,40 +62523,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "customPrice": { "properties": { "links": { "type": "object", @@ -58748,7 +62536,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -58759,53 +62547,19 @@ "properties": { "type": { "type": "string", - "example": "webhook_event_log" + "example": "custom_price" }, "id": { "type": "string", - "example": "82557f6f51ca956bee524cede1375331" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "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": { + "advancedProductCatalog": { "properties": { "links": { "type": "object", @@ -58813,7 +62567,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" } } }, @@ -58822,20 +62576,24 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "ff9540fcefd24264341c5a70314b71be" } } } }, "type": "object" - }, - "parent": { - "description": "Unique identity of flow sequence.", + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customers": { "properties": { "links": { "type": "object", @@ -58843,28 +62601,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } } } } }, "type": "object" }, - "children": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -58872,7 +62632,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, @@ -58883,11 +62643,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "sales_channel" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -58895,7 +62655,7 @@ }, "type": "object" }, - "appFlowAction": { + "registrationSalesChannels": { "properties": { "links": { "type": "object", @@ -58903,21 +62663,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8ba9ae8a60ecf9be421e333b95703a68" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "ffc8e76c1fe257d563b9d0024a50620b" + } } } } @@ -58932,57 +62694,42 @@ } ] }, - "FlowSequence": { - "description": "Added since version: 6.4.6.0", + "CustomerGroup": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "flowId" + "name" ], "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.", + "name": { "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" + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" }, - "displayGroup": { - "description": "The group to which the flow sequence is visible.", - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, - "trueCase": { + "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationTitle": { + "type": "string" }, - "customFields": { - "type": "object" + "registrationIntroduction": { + "type": "string" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" }, "createdAt": { "type": "string", @@ -58994,9 +62741,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "delayActions": { + "customPrice": { "properties": { "links": { "type": "object", @@ -59004,7 +62754,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -59015,11 +62765,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "custom_price" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } @@ -59027,7 +62777,7 @@ }, "type": "object" }, - "webhookEventLogs": { + "advancedProductCatalog": { "properties": { "links": { "type": "object", @@ -59035,23 +62785,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook_event_log" - }, - "id": { - "type": "string", - "example": "82557f6f51ca956bee524cede1375331" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ff9540fcefd24264341c5a70314b71be" } } } @@ -59061,239 +62809,62 @@ }, "type": "object" }, - "flow": { - "$ref": "#/components/schemas/Flow" - }, - "rule": { - "$ref": "#/components/schemas/Rule" - }, - "parent": { - "$ref": "#/components/schemas/FlowSequence", - "description": "Unique identity of flow sequence." - }, - "children": { + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Customer" } }, - "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": { - "description": "Name of the flow template.", - "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": { - "description": "Name of the flow template.", - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "registrationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } } }, "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": { - "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": { - "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", + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", "required": [ - "id", - "originalName", - "path", - "expireDate" + "customerGroupId", + "salesChannelId" ], "properties": { "id": { "type": "string", "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" + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessToken": { - "description": "Secret key to access import-export file.", - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "log": { - "$ref": "#/components/schemas/ImportExportLog" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "ImportExportLogJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomerRecoveryJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -59301,54 +62872,23 @@ { "required": [ "id", - "activity", - "state", - "records", - "config" + "hash", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "activity": { - "type": "string" - }, - "state": { + "hash": { + "description": "Password hash for customer's account recovery.", "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": { + "customerId": { + "description": "Unique identity of the customer.", "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", @@ -59361,123 +62901,7 @@ }, "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": { + "customer": { "properties": { "links": { "type": "object", @@ -59485,7 +62909,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" + "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" } } }, @@ -59494,12 +62918,12 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1d6996fa1560fc40e5faad086b07ad18" + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -59514,58 +62938,27 @@ } ] }, - "ImportExportLog": { - "description": "Added since version: 6.0.0.0", + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", "required": [ "id", - "activity", - "state", - "records", - "config" + "hash", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "activity": { - "type": "string" - }, - "state": { + "hash": { + "description": "Password hash for customer's account recovery.", "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": { + "customerId": { + "description": "Unique identity of the customer.", "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", @@ -59576,26 +62969,13 @@ "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" + "customer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "ImportExportProfileJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomerSpecificFeaturesJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -59603,54 +62983,19 @@ { "required": [ "id", - "technicalName", - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure" + "customerId", + "features" ], "properties": { "id": { "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": { - "type": "object" - }, - "updateBy": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { + "features": { "type": "object" }, "createdAt": { @@ -59663,12 +63008,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "importExportLogs": { + "customer": { "properties": { "links": { "type": "object", @@ -59676,23 +63018,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" + "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" } } }, "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": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -59707,58 +63047,22 @@ } ] }, - "ImportExportProfile": { - "description": "Added since version: 6.0.0.0", + "CustomerSpecificFeatures": { "required": [ "id", - "technicalName", - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure" + "customerId", + "features" ], "properties": { "id": { "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": { - "type": "object" - }, - "updateBy": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { + "features": { "type": "object" }, "createdAt": { @@ -59771,20 +63075,42 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "importExportLogs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } + "customer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "IntegrationJsonApi": { + "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" @@ -59792,44 +63118,27 @@ { "required": [ "id", - "label", - "accessKey", - "secretAccessKey" + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "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.", + "customerId": { + "description": "Unique identity of the customer.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "admin": { - "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", - "type": "boolean" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "deletedAt": { - "description": "Date and time when the integration was deleted.", - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -59840,9 +63149,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "createdNotifications": { + "products": { "properties": { "links": { "type": "object", @@ -59850,7 +63159,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" } } }, @@ -59861,24 +63170,19 @@ "properties": { "type": { "type": "string", - "example": "notification" + "example": "customer_wishlist_product" }, "id": { "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "app": { + }, + "customer": { "properties": { "links": { "type": "object", @@ -59886,7 +63190,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" } } }, @@ -59895,50 +63199,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } - }, - "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" - } + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "aclRoles": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -59946,23 +63219,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "acl_role" - }, - "id": { - "type": "string", - "example": "e050a8081a3eb1d193c23cf0ef761183" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -59977,48 +63248,31 @@ } ] }, - "Integration": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", "required": [ "id", - "label", - "accessKey", - "secretAccessKey" + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "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.", + "customerId": { + "description": "Unique identity of the customer.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "admin": { - "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", - "type": "boolean" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "deletedAt": { - "description": "Date and time when the integration was deleted.", - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60029,90 +63283,23 @@ "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" - }, - "stateMachineHistoryEntries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - }, - "aclRoles": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/AclRole" + "$ref": "#/components/schemas/CustomerWishlistProduct" } - } - }, - "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" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "role": { - "$ref": "#/components/schemas/AclRole" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -60120,47 +63307,25 @@ { "required": [ "id", - "name", - "url" + "productId", + "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productId": { + "description": "Unique identity of the product.", "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": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60174,12 +63339,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "tags": { + "wishlist": { "properties": { "links": { "type": "object", @@ -60187,31 +63349,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "723edf7c24638ed18d2fa831e647a5cc" } } } }, "type": "object" }, - "cmsPage": { - "description": "CMS page layout for the landing page", + "product": { "properties": { "links": { "type": "object", @@ -60219,7 +63378,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" } } }, @@ -60228,19 +63387,126 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" - }, - "salesChannels": { + } + }, + "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": { + "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" + } + }, + "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", @@ -60248,7 +63514,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" } } }, @@ -60259,11 +63525,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "shipping_method" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -60271,8 +63537,7 @@ }, "type": "object" }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", + "products": { "properties": { "links": { "type": "object", @@ -60280,7 +63545,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" } } }, @@ -60291,11 +63556,11 @@ "properties": { "type": { "type": "string", - "example": "seo_url" + "example": "product" }, "id": { "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -60311,53 +63576,39 @@ } ] }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", + "DeliveryTime": { + "description": "Added since version: 6.0.0.0", "required": [ "id", "name", - "url" + "min", + "max", + "unit" ], "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" + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" }, - "keywords": { - "type": "string" + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" }, - "url": { + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -60372,97 +63623,22 @@ "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": { + "shippingMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/ShippingMethod" } }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Product" } } }, "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": { + "DocumentJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -60471,34 +63647,54 @@ { "required": [ "id", - "localeId", - "name" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "description": "Unique identity of locale.", + "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { - "description": "Unique identity of translation code.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the language.", + "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" }, - "active": { - "type": "boolean" + "documentNumber": { + "type": "string" }, "customFields": { "type": "object" @@ -60513,9 +63709,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "subscriptions": { + "documentType": { "properties": { "links": { "type": "object", @@ -60523,61 +63719,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, - "type": "object" - }, - "mediaAiTagTranslation": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag_translation" - }, - "id": { - "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" - } + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "quotes": { + "order": { "properties": { "links": { "type": "object", @@ -60585,61 +63748,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - }, - "b2bEmployees": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "2193894cca6bb5864b8607f09be77ace" - } + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "advancedSearchSynonyms": { + "referencedDocument": { "properties": { "links": { "type": "object", @@ -60647,61 +63777,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_synonym" - }, - "id": { - "type": "string", - "example": "a139d0125b356216337e8386fca65e22" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } + "example": "document" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "75c3c346b0ef4f319e71925ce164a9ae" } } } }, "type": "object" }, - "b2bAppScriptConditions": { + "dependentDocuments": { "properties": { "links": { "type": "object", @@ -60709,7 +63806,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" } } }, @@ -60720,25 +63817,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule_app_script_condition_translation" + "example": "document" }, "id": { "type": "string", - "example": "880f55611c0f2ac1026271d799698c6e" + "example": "e74b269b7d5f269051463569677da2a0" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of language.", + }, + "documentMediaFile": { "properties": { "links": { "type": "object", @@ -60746,7 +63837,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" } } }, @@ -60755,20 +63846,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "ac7db1e6be481d6422fc63700e08279d" } } } }, "type": "object" }, - "locale": { - "description": "Locale defining regional settings (date, time, number formats)", + "documentA11yMediaFile": { "properties": { "links": { "type": "object", @@ -60776,7 +63866,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" } } }, @@ -60785,20 +63875,182 @@ "properties": { "type": { "type": "string", - "example": "locale" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fb216d9e8791e63c8d12bdc420956839" + "example": "0ea973a1104089c9d0f93bdb06c47cab" } } } }, "type": "object" - }, - "translationCode": { - "description": "Locale used for translating content", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Document": { + "description": "Added since version: 6.0.0.0", + "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 + }, + "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": { + "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", @@ -60806,7 +64058,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" } } }, @@ -60815,20 +64067,20 @@ "properties": { "type": { "type": "string", - "example": "locale" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ef2035242b8fcb7b61c3a41850e60b3" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "children": { - "description": "Child languages inheriting from this parent language", + "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -60836,23 +64088,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" } } } @@ -60867,7 +64117,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" } } }, @@ -60878,7 +64128,7 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "document_base_config_sales_channel" }, "id": { "type": "string", @@ -60889,8 +64139,133 @@ } }, "type": "object" - }, - "salesChannelDefaultAssignments": { + } + }, + "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": { + "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" + } + } + }, + "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": { + "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": { + "documentType": { "properties": { "links": { "type": "object", @@ -60898,61 +64273,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, "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": { "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" - } + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "customers": { + "documentBaseConfig": { "properties": { "links": { "type": "object", @@ -60960,30 +64302,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56e59df02965ebf8eadea49fa0aadd47" } } } }, "type": "object" }, - "newsletterRecipients": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -60991,30 +64331,126 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "newsletter_recipient" - }, - "id": { - "type": "string", - "example": "2217f01dc5cddfd5b60387c39867f58e" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "orders": { + } + }, + "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": { + "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" + } + }, + "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" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "quoteDocuments": { "properties": { "links": { "type": "object", @@ -61022,7 +64458,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, @@ -61033,19 +64469,24 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "quote_document" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" - }, - "productSearchKeywords": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "documents": { "properties": { "links": { "type": "object", @@ -61053,7 +64494,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, @@ -61064,11 +64505,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_keyword" + "example": "document" }, "id": { "type": "string", - "example": "ea9cb6522f347c9212c9459d63c645f4" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -61076,7 +64517,7 @@ }, "type": "object" }, - "productKeywordDictionaries": { + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -61084,7 +64525,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" } } }, @@ -61095,11 +64536,11 @@ "properties": { "type": { "type": "string", - "example": "product_keyword_dictionary" + "example": "document_base_config" }, "id": { "type": "string", - "example": "660e189a383ca4eb148e25eb0df85988" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } @@ -61107,7 +64548,7 @@ }, "type": "object" }, - "productReviews": { + "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", @@ -61115,7 +64556,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" } } }, @@ -61126,46 +64567,17 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "document_base_config_sales_channel" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } } }, "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" @@ -61175,11 +64587,11 @@ } ] }, - "Language": { + "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "localeId", + "technicalName", "name" ], "properties": { @@ -61187,26 +64599,12 @@ "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" + "technicalName": { + "description": "Technical name of document type.", + "type": "string" }, "customFields": { "type": "object" @@ -61221,9 +64619,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "subscriptions": { + "quoteDocuments": { "properties": { "links": { "type": "object", @@ -61231,7 +64632,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, @@ -61242,174 +64643,268 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "quote_document" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "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}$" }, - "mediaAiTagTranslation": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag_translation" - }, - "id": { - "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" - } - } - } - } - }, - "type": "object" + "name": { + "description": "Name of the flow.", + "type": "string" }, - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, + "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" }, - "b2bEmployees": { + "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": { - "links": { - "type": "object", + "delayActions": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "2193894cca6bb5864b8607f09be77ace" + "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" }, - "advancedSearchSynonyms": { + "relationships": { "properties": { - "links": { - "type": "object", + "sequences": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_synonym" - }, - "id": { - "type": "string", - "example": "a139d0125b356216337e8386fca65e22" + "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" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" - } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "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" - }, - "b2bAppScriptConditions": { + } + }, + "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", @@ -61417,7 +64912,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" } } }, @@ -61428,11 +64923,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule_app_script_condition_translation" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "880f55611c0f2ac1026271d799698c6e" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -61443,87 +64938,20 @@ }, "type": "object" }, - "parent": { - "$ref": "#/components/schemas/Language", - "description": "Unique identity of language." - }, - "locale": { - "$ref": "#/components/schemas/Locale", - "description": "Locale defining regional settings (date, time, number formats)" - }, - "translationCode": { - "$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" - } - }, - "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": { + "sequences": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/FlowSequence" } }, - "productSearchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "appFlowEvent": { + "$ref": "#/components/schemas/AppFlowEvent" } }, "type": "object" }, - "LocaleJsonApi": { - "description": "Added since version: 6.0.0.0", + "FlowSequenceJsonApi": { + "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -61531,28 +64959,54 @@ { "required": [ "id", - "code", - "name", - "territory" + "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "description": "Code given to the locale. For example: en-CA.", - "type": "string" + "flowId": { + "description": "Unique identity of flow.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "territory": { + "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", @@ -61563,12 +65017,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "relationships": { + "extensions": { "properties": { - "languages": { + "delayActions": { "properties": { "links": { "type": "object", @@ -61576,7 +65027,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, @@ -61587,11 +65038,11 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "f3e334d42863e8250c7d03efefbfd387" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -61599,7 +65050,7 @@ }, "type": "object" }, - "users": { + "webhookEventLogs": { "properties": { "links": { "type": "object", @@ -61607,7 +65058,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, @@ -61618,17 +65069,170 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "webhook_event_log" }, "id": { "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" + "example": "82557f6f51ca956bee524cede1375331" + } + } + } + } + }, + "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": { + "description": "Unique identity of flow sequence.", + "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" @@ -61638,32 +65242,58 @@ } ] }, - "Locale": { - "description": "Added since version: 6.0.0.0", + "FlowSequence": { + "description": "Added since version: 6.4.6.0", "required": [ "id", - "code", - "name", - "territory" + "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "description": "Code given to the locale. For example: en-CA.", + "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" }, - "name": { - "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" }, - "territory": { - "type": "string" + "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", @@ -61674,55 +65304,116 @@ "format": "date-time", "readOnly": true }, - "translated": { + "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" }, - "languages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } + "flow": { + "$ref": "#/components/schemas/Flow" }, - "users": { + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "parent": { + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." + }, + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/FlowSequence" } + }, + "appFlowAction": { + "$ref": "#/components/schemas/AppFlowAction" } }, "type": "object" }, - "LogEntryJsonApi": { - "description": "Added since version: 6.0.0.0", + "FlowTemplateJsonApi": { + "description": "Added since version: 6.4.18.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "id" + "id", + "name" ], "properties": { "id": { "type": "string", "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" - }, - "channel": { + "name": { + "description": "Name of the flow template.", "type": "string" }, - "context": { - "type": "object" - }, - "extra": { + "config": { "type": "object" }, "createdAt": { @@ -61740,32 +65431,22 @@ } ] }, - "LogEntry": { - "description": "Added since version: 6.0.0.0", + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", "required": [ - "id" + "id", + "name" ], "properties": { "id": { "type": "string", "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" - }, - "channel": { + "name": { + "description": "Name of the flow template.", "type": "string" }, - "context": { - "type": "object" - }, - "extra": { + "config": { "type": "object" }, "createdAt": { @@ -61781,7 +65462,7 @@ }, "type": "object" }, - "MailHeaderFooterJsonApi": { + "ImportExportFileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -61790,32 +65471,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": { @@ -61828,12 +65512,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "log": { "properties": { "links": { "type": "object", @@ -61841,23 +65522,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" } } } @@ -61872,36 +65551,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": { @@ -61914,19 +65596,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": [ { @@ -61935,39 +65611,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": { @@ -61980,12 +65669,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "mailTemplateType": { + "user": { "properties": { "links": { "type": "object", @@ -61993,7 +65679,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, @@ -62002,19 +65688,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", @@ -62022,23 +65708,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" } } } @@ -62053,109 +65824,87 @@ } ] }, - "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": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "systemDefault": { - "type": "boolean" - }, - "senderName": { - "type": "string" - }, - "description": { + "activity": { "type": "string" }, - "subject": { + "state": { "type": "string" }, - "contentHtml": { - "type": "string" + "records": { + "type": "integer", + "format": "int64" }, - "contentPlain": { - "type": "string" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "fileId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "invalidRecordsLogId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "username": { + "type": "string" }, - "mailTemplateType": { - "$ref": "#/components/schemas/MailTemplateType" + "profileName": { + "type": "string" }, - "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}$" + "config": { + "type": "object" + }, + "result": { + "type": "object" }, - "mailTemplateId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "languageId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "user": { + "$ref": "#/components/schemas/User" }, - "position": { - "type": "integer", - "format": "int64" + "profile": { + "$ref": "#/components/schemas/ImportExportProfile" }, - "mailTemplate": { - "$ref": "#/components/schemas/MailTemplate" + "file": { + "$ref": "#/components/schemas/ImportExportFile" }, - "media": { - "$ref": "#/components/schemas/Media" + "invalidRecordsLog": { + "$ref": "#/components/schemas/ImportExportLog" + }, + "failedImportLog": { + "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, - "MailTemplateTypeJsonApi": { + "ImportExportProfileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -62165,27 +65914,53 @@ "required": [ "id", "technicalName", - "name" + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "technicalName": { "type": "string" }, - "technicalName": { - "description": "Technical name of mail template.", + "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": { @@ -62203,7 +65978,7 @@ }, "relationships": { "properties": { - "mailTemplates": { + "importExportLogs": { "properties": { "links": { "type": "object", @@ -62211,7 +65986,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" + "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" } } }, @@ -62222,11 +65997,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template" + "example": "import_export_log" }, "id": { "type": "string", - "example": "e6f502f7d88de75db45325d22998cf6d" + "example": "e4ca733e3c1da4bff4cd4b6078f2237a" } } } @@ -62242,32 +66017,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": { - "description": "Technical name of mail template.", + "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": { @@ -62283,17 +66084,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" @@ -62301,37 +66102,43 @@ { "required": [ "id", - "productId", - "categoryId", - "salesChannelId" + "label", + "accessKey", + "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", - "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": { - "description": "Unique identity of the category.", - "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": { - "description": "Unique identity of the sales channel.", + "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", @@ -62343,9 +66150,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "product": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -62353,28 +66160,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "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": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } } } } }, "type": "object" - }, - "category": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "app": { "properties": { "links": { "type": "object", @@ -62382,7 +66196,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, @@ -62391,19 +66205,19 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c4ef352f74e502ef5e7bc98e6f4e493d" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "salesChannel": { + "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", @@ -62411,21 +66225,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" + "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": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" + } } } } @@ -62440,41 +66287,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": { - "description": "Unique identity of the product.", - "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": { - "description": "Unique identity of the category.", - "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": { - "description": "Unique identity of the sales channel.", + "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", @@ -62486,182 +66339,90 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "category": { - "$ref": "#/components/schemas/Category" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "MeasurementDisplayUnitJsonApi": { - "description": "Added since version: 6.7.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" - ], + "extensions": { "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": { + "createdNotifications": { "properties": { - "measurementSystem": { + "links": { + "type": "object", "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" - } + "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" + }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, + "aclRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } - ] + }, + "type": "object" }, - "MeasurementDisplayUnit": { - "description": "Added since version: 6.7.1.0", + "IntegrationRole": { + "description": "Added since version: 6.3.3.0", "required": [ - "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" + "integrationId", + "aclRoleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementSystemId": { + "integrationId": { "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": { + "aclRoleId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "integration": { + "$ref": "#/components/schemas/Integration" }, - "measurementSystem": { - "$ref": "#/components/schemas/MeasurementSystem" + "role": { + "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, - "MeasurementSystemJsonApi": { - "description": "Added since version: 6.7.1.0", + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -62669,15 +66430,20 @@ { "required": [ "id", - "technicalName" + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" }, "name": { "type": "string" @@ -62685,6 +66451,29 @@ "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", @@ -62700,7 +66489,7 @@ }, "relationships": { "properties": { - "units": { + "tags": { "properties": { "links": { "type": "object", @@ -62708,7 +66497,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" } } }, @@ -62719,11 +66508,104 @@ "properties": { "type": { "type": "string", - "example": "measurement_display_unit" + "example": "tag" }, "id": { "type": "string", - "example": "b98b3dfbd27e710e6c3ceeae58770b52" + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "description": "CMS page layout for the landing page", + "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": { + "description": "SEO-friendly URLs for the landing page across different sales channels", + "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" } } } @@ -62739,19 +66621,24 @@ } ] }, - "MeasurementSystem": { - "description": "Added since version: 6.7.1.0", + "LandingPage": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "technicalName" + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" }, "name": { "type": "string" @@ -62759,6 +66646,29 @@ "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", @@ -62772,16 +66682,97 @@ "translated": { "type": "object" }, - "units": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$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" }, - "MediaJsonApi": { + "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": [ { @@ -62789,85 +66780,39 @@ }, { "required": [ - "id" + "id", + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "description": "Unique identity of the user", + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaFolderId": { - "description": "Unique identity of the media folder.", + "localeId": { + "description": "Unique identity of locale.", "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.", + "translationCodeId": { + "description": "Unique identity of translation code.", "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" + "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": { - "description": "When `true`, the media display is kept private.", + "active": { "type": "boolean" }, "customFields": { "type": "object" }, - "fileHash": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -62878,43 +66823,9 @@ "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": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -62922,7 +66833,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" } } }, @@ -62933,11 +66844,11 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "subscription" }, "id": { "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -62945,36 +66856,7 @@ }, "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": { + "mediaAiTagTranslation": { "properties": { "links": { "type": "object", @@ -62982,7 +66864,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" } } }, @@ -62993,11 +66875,11 @@ "properties": { "type": { "type": "string", - "example": "sso_provider" + "example": "media_ai_tag_translation" }, "id": { "type": "string", - "example": "520b66891556bf9309da72937c4f1f98" + "example": "e78da60cc3106508ef465909fa4cb138" } } } @@ -63005,7 +66887,7 @@ }, "type": "object" }, - "quoteDocuments": { + "quotes": { "properties": { "links": { "type": "object", @@ -63013,7 +66895,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" } } }, @@ -63024,11 +66906,11 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "quote" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -63036,7 +66918,7 @@ }, "type": "object" }, - "quoteLineItems": { + "b2bEmployees": { "properties": { "links": { "type": "object", @@ -63044,7 +66926,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" } } }, @@ -63055,11 +66937,11 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "example": "2193894cca6bb5864b8607f09be77ace" } } } @@ -63067,43 +66949,7 @@ }, "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" - }, - "relationships": { - "properties": { - "tags": { + "advancedSearchSynonyms": { "properties": { "links": { "type": "object", @@ -63111,7 +66957,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" } } }, @@ -63122,11 +66968,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "advanced_search_synonym" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "a139d0125b356216337e8386fca65e22" } } } @@ -63134,8 +66980,7 @@ }, "type": "object" }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -63143,7 +66988,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" } } }, @@ -63154,48 +66999,19 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "b2b_components_pending_order" }, "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" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } } } } }, "type": "object" }, - "categories": { + "b2bAppScriptConditions": { "properties": { "links": { "type": "object", @@ -63203,7 +67019,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" } } }, @@ -63214,19 +67030,25 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "b2b_components_approval_rule_app_script_condition_translation" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "880f55611c0f2ac1026271d799698c6e" } } } } }, "type": "object" - }, - "productManufacturers": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -63234,30 +67056,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_manufacturer" - }, - "id": { - "type": "string", - "example": "30e3a0f8868364c06aa4be63426c1c79" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "productMedia": { + "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -63265,30 +67086,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "example": "2b5e079404830806ea36b6c17438cffd" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, - "productDownloads": { + "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -63296,30 +67116,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_download" - }, - "id": { - "type": "string", - "example": "86db490c1f4f52d155dbdb978b1f45d3" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ef2035242b8fcb7b61c3a41850e60b3" } } } }, "type": "object" }, - "orderLineItemDownloads": { + "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -63327,7 +67146,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" } } }, @@ -63338,11 +67157,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "language" }, "id": { "type": "string", - "example": "8c0a5ecd281c97a912c27c0237b3848f" + "example": "268184c12df027f536154d099d497b31" } } } @@ -63350,7 +67169,7 @@ }, "type": "object" }, - "avatarUsers": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -63358,7 +67177,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" } } }, @@ -63369,11 +67188,11 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "sales_channel" }, "id": { "type": "string", - "example": "1fc09529f6c95370eb20b81318ff601f" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -63381,7 +67200,7 @@ }, "type": "object" }, - "mediaFolder": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -63389,28 +67208,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_folder" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70605921a592ee735964394f7948773b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "propertyGroupOptions": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -63418,7 +67239,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" } } }, @@ -63429,11 +67250,11 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "789104e3568fde835b6239b251d4aa07" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } @@ -63441,7 +67262,7 @@ }, "type": "object" }, - "mailTemplateMedia": { + "customers": { "properties": { "links": { "type": "object", @@ -63449,7 +67270,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" } } }, @@ -63460,11 +67281,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template_media" + "example": "customer" }, "id": { "type": "string", - "example": "9970132c8439a2e630b655812b031459" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -63472,7 +67293,7 @@ }, "type": "object" }, - "documentBaseConfigs": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -63480,7 +67301,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" } } }, @@ -63491,11 +67312,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } @@ -63503,7 +67324,7 @@ }, "type": "object" }, - "shippingMethods": { + "orders": { "properties": { "links": { "type": "object", @@ -63511,7 +67332,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" } } }, @@ -63522,11 +67343,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "order" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -63534,7 +67355,7 @@ }, "type": "object" }, - "paymentMethods": { + "productSearchKeywords": { "properties": { "links": { "type": "object", @@ -63542,7 +67363,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" } } }, @@ -63553,11 +67374,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "product_search_keyword" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "ea9cb6522f347c9212c9459d63c645f4" } } } @@ -63565,7 +67386,7 @@ }, "type": "object" }, - "productConfiguratorSettings": { + "productKeywordDictionaries": { "properties": { "links": { "type": "object", @@ -63573,7 +67394,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" } } }, @@ -63584,11 +67405,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "product_keyword_dictionary" }, "id": { "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + "example": "660e189a383ca4eb148e25eb0df85988" } } } @@ -63596,7 +67417,7 @@ }, "type": "object" }, - "orderLineItems": { + "productReviews": { "properties": { "links": { "type": "object", @@ -63604,7 +67425,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" } } }, @@ -63615,11 +67436,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "product_review" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "01e78541ea343ed72424a5222796a4cd" } } } @@ -63627,7 +67448,7 @@ }, "type": "object" }, - "cmsBlocks": { + "productSearchConfig": { "properties": { "links": { "type": "object", @@ -63635,30 +67456,429 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" - } + "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": { + "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" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + } + } }, - "cmsSections": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" + }, + "mediaAiTagTranslation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag_translation" + }, + "id": { + "type": "string", + "example": "e78da60cc3106508ef465909fa4cb138" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "b2bEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "2193894cca6bb5864b8607f09be77ace" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchSynonyms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_synonym" + }, + "id": { + "type": "string", + "example": "a139d0125b356216337e8386fca65e22" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "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" + }, + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." + }, + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" + }, + "translationCode": { + "$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" + } + }, + "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": { + "description": "Code given to the locale. For example: en-CA.", + "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", @@ -63666,7 +67886,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" } } }, @@ -63677,11 +67897,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "language" }, "id": { "type": "string", - "example": "53be3cc1c4a8f41af67a90cf9fd09194" + "example": "f3e334d42863e8250c7d03efefbfd387" } } } @@ -63689,7 +67909,7 @@ }, "type": "object" }, - "cmsPages": { + "users": { "properties": { "links": { "type": "object", @@ -63697,7 +67917,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" } } }, @@ -63708,19 +67928,222 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "user" }, "id": { "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" + "example": "9bc65c2abec141778ffaa729489f3e87" } } } } }, "type": "object" - }, - "documents": { + } + }, + "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": { + "description": "Code given to the locale. For example: en-CA.", + "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": { + "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" + }, + "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": { + "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" + }, + "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", @@ -63728,7 +68151,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, @@ -63739,19 +68162,143 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "sales_channel" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" - }, - "a11yDocuments": { + } + }, + "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" + }, + "wasModifiedByUser": { + "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", @@ -63759,61 +68306,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document" - }, - "id": { - "type": "string", - "example": "f6c460e0d75110fa1ec7529fe364dbb5" - } - } - } - } - }, - "type": "object" - }, - "appPaymentMethods": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "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" - } + "example": "mail_template_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, - "appShippingMethods": { + "media": { "properties": { "links": { "type": "object", @@ -63821,7 +68335,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, @@ -63832,11 +68346,11 @@ "properties": { "type": { "type": "string", - "example": "app_shipping_method" + "example": "mail_template_media" }, "id": { "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -63852,88 +68366,48 @@ } ] }, - "Media": { + "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "id" + "id", + "mailTemplateTypeId", + "subject", + "contentHtml", + "contentPlain" ], "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.", + "mailTemplateTypeId": { "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" + "systemDefault": { + "type": "boolean" }, - "uploadedAt": { - "description": "Date and time at which media was added.", - "type": "string", - "format": "date-time", - "readOnly": true + "wasModifiedByUser": { + "type": "boolean" }, - "fileName": { - "description": "Name of the media file uploaded.", + "senderName": { "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": { + "description": { "type": "string" }, - "title": { + "subject": { "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "contentHtml": { "type": "string" }, - "path": { + "contentPlain": { "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", @@ -63947,369 +68421,401 @@ "translated": { "type": "object" }, - "extensions": { + "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": { - "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" - } - } - } - } - }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "description": "Technical name of mail template.", + "type": "string" + }, + "availableEntities": { "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" - } - } - } - } - }, + "customFields": { "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" - } - } - } - }, + "templateData": { "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" - } - } - } - } - }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" }, - "quoteDocuments": { + "relationships": { "properties": { - "links": { - "type": "object", + "mailTemplates": { "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" + "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": { + "description": "Technical name of mail template.", + "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}$" }, - "quoteLineItems": { + "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": { - "links": { - "type": "object", + "product": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" + "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" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "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" - }, - "spatialObjects": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" - } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "spatial_scene_object" - }, - "id": { - "type": "string", - "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + "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}$" }, - "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" - } + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productConfiguratorSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "categoryId": { + "description": "Unique identity of the category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "a11yDocuments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "product": { + "$ref": "#/components/schemas/Product" }, - "appPaymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "category": { + "$ref": "#/components/schemas/Category" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "MediaAiTagJsonApi": { + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -64317,31 +68823,44 @@ { "required": [ "id", - "mediaId" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "default": { + "type": "boolean" }, - "errorCode": { + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { "type": "integer", "format": "int64" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "name": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -64358,7 +68877,7 @@ }, "relationships": { "properties": { - "media": { + "measurementSystem": { "properties": { "links": { "type": "object", @@ -64366,7 +68885,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" } } }, @@ -64375,12 +68894,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "measurement_system" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "c0484ac171c930ce54e78cd2e0d80e5a" } } } @@ -64395,34 +68914,48 @@ } ] }, - "MediaAiTag": { + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "mediaId" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "default": { + "type": "boolean" }, - "errorCode": { + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { "type": "integer", "format": "int64" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "name": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -64437,14 +68970,14 @@ "translated": { "type": "object" }, - "media": { - "$ref": "#/components/schemas/Media" + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "MediaDefaultFolderJsonApi": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -64452,15 +68985,17 @@ { "required": [ "id", - "entity" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "Indicates in which particular entity.", + "technicalName": { + "type": "string" + }, + "name": { "type": "string" }, "customFields": { @@ -64476,9 +69011,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "folder": { + "units": { "properties": { "links": { "type": "object", @@ -64486,21 +69024,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" } } }, "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": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } } } } @@ -64515,19 +69055,21 @@ } ] }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "entity" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "Indicates in which particular entity.", + "technicalName": { + "type": "string" + }, + "name": { "type": "string" }, "customFields": { @@ -64543,13 +69085,19 @@ "format": "date-time", "readOnly": true }, - "folder": { - "$ref": "#/components/schemas/MediaFolder" + "translated": { + "type": "object" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } } }, "type": "object" }, - "MediaFolderJsonApi": { + "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -64557,50 +69105,85 @@ }, { "required": [ - "id", - "configurationId", - "name" + "id" ], "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.", + "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultFolderId": { - "description": "Unique identity of default folder.", + "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "childCount": { + "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 }, - "path": { - "description": "A relative URL to the media folder.", - "type": "string", + "metaData": { + "type": "object", "readOnly": true }, - "name": { - "description": "Name of media folder.", + "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", @@ -64611,10 +69194,74 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "parent": { - "description": "Unique identity of media folder.", + "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", @@ -64622,7 +69269,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" } } }, @@ -64631,19 +69278,19 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "media_ai_tag" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "3c88197809d464216a8c40a8db191b38" } } } }, "type": "object" }, - "children": { + "ssoProviders": { "properties": { "links": { "type": "object", @@ -64651,7 +69298,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" } } }, @@ -64662,11 +69309,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "sso_provider" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "520b66891556bf9309da72937c4f1f98" } } } @@ -64674,7 +69321,7 @@ }, "type": "object" }, - "media": { + "quoteDocuments": { "properties": { "links": { "type": "object", @@ -64682,7 +69329,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" } } }, @@ -64693,11 +69340,11 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "quote_document" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } @@ -64705,7 +69352,7 @@ }, "type": "object" }, - "defaultFolder": { + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -64713,28 +69360,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_default_folder" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "251dcc9b1621d34e6b01ee14c26b3027" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } } } } }, "type": "object" }, - "configuration": { + "spatialObjects": { "properties": { "links": { "type": "object", @@ -64742,21 +69391,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" } } }, "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": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } } } } @@ -64765,145 +69416,10 @@ } }, "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": { + "tags": { "properties": { "links": { "type": "object", @@ -64911,7 +69427,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" + "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" } } }, @@ -64922,11 +69438,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "tag" }, "id": { "type": "string", - "example": "6e8238687513bde2e85821c839c597c6" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -64934,7 +69450,8 @@ }, "type": "object" }, - "mediaThumbnailSizes": { + "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -64942,7 +69459,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" } } }, @@ -64953,202 +69470,110 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail_size" + "example": "media_thumbnail" }, "id": { "type": "string", - "example": "44dee48a0006e8db2fcec2a5e1456449" + "example": "3b8779ba05b8f0aed49650f3ff8beb4b" } } } } }, "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": { - "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": { + }, + "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", @@ -65156,28 +69581,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" + "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": { - "type": { + "related": { "type": "string", - "example": "media" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "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" }, - "mediaThumbnailSize": { + "avatarUsers": { "properties": { "links": { "type": "object", @@ -65185,7 +69674,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" + "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" } } }, @@ -65194,132 +69714,19 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail_size" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0d0b8659a3a47e9d7e1481961f127fd0" + "example": "70605921a592ee735964394f7948773b" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "MediaThumbnail": { - "description": "Added since version: 6.0.0.0", - "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 - }, - "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": { - "id": { - "type": "string", - "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" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "mediaFolderConfigurations": { + }, + "propertyGroupOptions": { "properties": { "links": { "type": "object", @@ -65327,7 +69734,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" + "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" } } }, @@ -65338,11 +69745,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder_configuration" + "example": "property_group_option" }, "id": { "type": "string", - "example": "056df7a700173d83ebb685b1a890f09b" + "example": "789104e3568fde835b6239b251d4aa07" } } } @@ -65350,7 +69757,7 @@ }, "type": "object" }, - "mediaThumbnails": { + "mailTemplateMedia": { "properties": { "links": { "type": "object", @@ -65358,7 +69765,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" } } }, @@ -65369,174 +69776,112 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "mail_template_media" }, "id": { "type": "string", - "example": "76ebc340ac8f9754c760c3ec742d2407" + "example": "9970132c8439a2e630b655812b031459" } } } } }, "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": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64" - }, - "height": { - "description": "Height of the thumbnail.", - "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" - } - }, - "mediaThumbnails": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - }, - "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": { - "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", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct" - ] - }, - "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}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "tags": { + }, + "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", @@ -65544,7 +69889,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" } } }, @@ -65555,11 +69900,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" } } } @@ -65567,7 +69912,7 @@ }, "type": "object" }, - "salutation": { + "productOpenGraphImages": { "properties": { "links": { "type": "object", @@ -65575,28 +69920,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" } } }, "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": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } } } } }, "type": "object" }, - "language": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -65604,28 +69951,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" } } }, "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": "order_line_item" + }, + "id": { + "type": "string", + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + } } } } }, "type": "object" }, - "salesChannel": { + "cmsBlocks": { "properties": { "links": { "type": "object", @@ -65633,230 +69982,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" } } }, "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": "cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } } } } }, "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": { - "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", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct" - ] - }, - "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}$" - }, - "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": { - "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 - }, - "relationships": { - "properties": { - "createdByIntegration": { + }, + "cmsSections": { "properties": { "links": { "type": "object", @@ -65864,28 +70013,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "4698501400b26be8a41def09646e1b59" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "example": "53be3cc1c4a8f41af67a90cf9fd09194" + } } } } }, "type": "object" }, - "createdByUser": { + "cmsPages": { "properties": { "links": { "type": "object", @@ -65893,158 +70044,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" } } }, "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": "cms_page" + }, + "id": { + "type": "string", + "example": "e676148cc6ffb82b89b3903ecaed2d16" + } } } } }, "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}$" - }, - "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": { - "type": "string" - }, - "description": { - "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" - }, - "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": { + }, + "documents": { "properties": { "links": { "type": "object", @@ -66052,28 +70075,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" + "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + }, + "a11yDocuments": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "number_range_type" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" + "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" }, - "numberRangeSalesChannels": { + "appPaymentMethods": { "properties": { "links": { "type": "object", @@ -66081,7 +70137,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" + "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" } } }, @@ -66092,11 +70148,11 @@ "properties": { "type": { "type": "string", - "example": "number_range_sales_channel" + "example": "app_payment_method" }, "id": { "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" + "example": "e53c737d351047e64a02b7a2a4caffe3" } } } @@ -66104,7 +70160,7 @@ }, "type": "object" }, - "state": { + "appShippingMethods": { "properties": { "links": { "type": "object", @@ -66112,21 +70168,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" + "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" } } }, "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": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } } } } @@ -66141,48 +70199,88 @@ } ] }, - "NumberRange": { + "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "typeId", - "global", - "pattern", - "start", - "name" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "typeId": { - "description": "Unique identity of type.", + "userId": { + "description": "Unique identity of the user", "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" + "mediaFolderId": { + "description": "Unique identity of the media folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, - "description": { + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, - "pattern": { - "description": "Custom formatting in order to include for example, the date in the number range.", + "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" }, - "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", + "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", - "format": "int64" + "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", @@ -66196,211 +70294,375 @@ "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" - ], + "extensions": { "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 - }, - "relationships": { + "themes": { "properties": { - "numberRange": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" - } + "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" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" - } + } + } + } + }, + "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" + }, + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + } + } }, - "salesChannel": { + "data": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" - } - } + "type": { + "type": "string", + "example": "media_ai_tag" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } + "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" + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } }, - "numberRangeType": { + "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": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" - } + "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" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3d771a402fc5aa3349c2c15637058e8c" - } + } + } + } + }, + "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" } }, "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}$" + "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" }, - "salesChannelId": { - "description": "Unique identity of Sales channels.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "propertyGroupOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } }, - "numberRangeTypeId": { - "description": "Unique identity of number rage type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "mailTemplateMedia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "productConfiguratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } }, - "numberRangeType": { - "$ref": "#/components/schemas/NumberRangeType" + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "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" }, - "NumberRangeStateJsonApi": { - "description": "Added since version: 6.0.0.0", + "MediaAiTagJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -66408,23 +70670,32 @@ { "required": [ "id", - "numberRangeId", - "lastValue" + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number range.", + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastValue": { + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { "type": "integer", "format": "int64" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -66435,9 +70706,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "numberRange": { + "media": { "properties": { "links": { "type": "object", @@ -66445,7 +70719,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" + "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" } } }, @@ -66454,12 +70728,12 @@ "properties": { "type": { "type": "string", - "example": "number_range" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -66474,27 +70748,35 @@ } ] }, - "NumberRangeState": { - "description": "Added since version: 6.0.0.0", + "MediaAiTag": { "required": [ "id", - "numberRangeId", - "lastValue" + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number range.", + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastValue": { + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { "type": "integer", "format": "int64" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -66505,13 +70787,16 @@ "format": "date-time", "readOnly": true }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "NumberRangeTypeJsonApi": { + "MediaDefaultFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -66520,25 +70805,17 @@ { "required": [ "id", - "global", - "typeName" + "entity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Name of the number range type.", - "type": "string" - }, - "typeName": { + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "global": { - "description": "When set to `true`, the defined number range type is used across all sales channels.", - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -66552,12 +70829,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "numberRanges": { + "folder": { "properties": { "links": { "type": "object", @@ -66565,54 +70839,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" + "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, "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": { "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" - } + "example": "media_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } @@ -66627,29 +70868,21 @@ } ] }, - "NumberRangeType": { + "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "global", - "typeName" + "entity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Name of the number range type.", - "type": "string" - }, - "typeName": { + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "global": { - "description": "When set to `true`, the defined number range type is used across all sales channels.", - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -66663,25 +70896,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "numberRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - }, - "numberRangeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } + "folder": { + "$ref": "#/components/schemas/MediaFolder" } }, "type": "object" }, - "OrderJsonApi": { + "MediaFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -66690,302 +70911,47 @@ { "required": [ "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding" + "configurationId", + "name" ], "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": { - "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}$" - }, - "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 - }, - "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", - "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": { - "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}$" - }, - "ruleIds": { - "type": "array", - "items": { - "type": "string" - } + "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", + "type": "boolean" }, - "customFields": { - "type": "object" + "configurationId": { + "description": "Unique identity of configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdById": { - "description": "Unique identity of createdBy.", + "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { - "description": "Unique identity of updatedBy.", + "parentId": { "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" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "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": { @@ -66998,9 +70964,10 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "subscription": { + "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -67008,7 +70975,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" } } }, @@ -67017,19 +70984,19 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "initialSubscriptions": { + "children": { "properties": { "links": { "type": "object", @@ -67037,7 +71004,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" } } }, @@ -67048,11 +71015,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "media_folder" }, "id": { "type": "string", - "example": "3b40c275cdd1f84402bcef5be1651f64" + "example": "268184c12df027f536154d099d497b31" } } } @@ -67060,7 +71027,7 @@ }, "type": "object" }, - "delayActions": { + "media": { "properties": { "links": { "type": "object", @@ -67068,7 +71035,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" } } }, @@ -67079,11 +71046,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "media" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -67091,7 +71058,7 @@ }, "type": "object" }, - "warehouseGroups": { + "defaultFolder": { "properties": { "links": { "type": "object", @@ -67099,61 +71066,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" } } }, "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": { "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" - } + "example": "media_default_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "251dcc9b1621d34e6b01ee14c26b3027" } } } }, "type": "object" }, - "returns": { + "configuration": { "properties": { "links": { "type": "object", @@ -67161,30 +71095,168 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder_configuration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ccd1066343c95877b75b79d47c36bebe" } } } }, "type": "object" - }, - "orderEmployee": { + } + }, + "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", @@ -67192,7 +71264,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" } } }, @@ -67203,11 +71275,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_order_employee" + "example": "media_folder" }, "id": { "type": "string", - "example": "5ea451c08a87db806089c4031601c29a" + "example": "6e8238687513bde2e85821c839c597c6" } } } @@ -67215,36 +71287,7 @@ }, "type": "object" }, - "quote": { - "properties": { - "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" - }, - "b2bPendingOrder": { + "mediaThumbnailSizes": { "properties": { "links": { "type": "object", @@ -67252,7 +71295,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" } } }, @@ -67263,19 +71306,202 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "media_thumbnail_size" }, "id": { "type": "string", - "example": "c7e0572188e2dec59215e8872024567e" + "example": "44dee48a0006e8db2fcec2a5e1456449" } } } } }, "type": "object" - }, - "organization": { + } + }, + "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", @@ -67283,7 +71509,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" } } }, @@ -67292,19 +71518,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "budget": { + "mediaThumbnailSize": { "properties": { "links": { "type": "object", @@ -67312,7 +71538,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" } } }, @@ -67321,12 +71547,12 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "media_thumbnail_size" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" + "example": "0d0b8659a3a47e9d7e1481961f127fd0" } } } @@ -67335,161 +71561,118 @@ } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaThumbnail": { + "description": "Added since version: 6.0.0.0", + "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 + }, + "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": { + "id": { + "type": "string", + "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" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, "relationships": { "properties": { - "stateMachineState": { - "description": "Current order state (e.g., open, in_progress, completed, cancelled)", - "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" - }, - "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", - "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": { - "description": "Currency used for the order", - "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": { - "description": "Language used when placing the order", + "mediaFolderConfigurations": { "properties": { "links": { "type": "object", @@ -67497,28 +71680,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" } } }, "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": "media_folder_configuration" + }, + "id": { + "type": "string", + "example": "056df7a700173d83ebb685b1a890f09b" + } } } } }, "type": "object" }, - "salesChannel": { + "mediaThumbnails": { "properties": { "links": { "type": "object", @@ -67526,29 +71711,185 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" } } }, "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_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } } } } }, "type": "object" - }, - "addresses": { - "description": "All addresses associated with the order (billing and shipping)", + } + }, + "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": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "height": { + "description": "Height of the thumbnail.", + "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" + } + }, + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + }, + "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": { + "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", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] + }, + "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}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "tags": { "properties": { "links": { "type": "object", @@ -67556,7 +71897,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" } } }, @@ -67567,11 +71908,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "tag" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -67579,8 +71920,7 @@ }, "type": "object" }, - "billingAddress": { - "description": "Billing address for the order", + "salutation": { "properties": { "links": { "type": "object", @@ -67588,7 +71928,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" } } }, @@ -67597,179 +71937,19 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "salutation" }, "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" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery" - }, - "id": { - "type": "string", - "example": "6fc31b6b9cd717cc0dcb81152308f8af" - } - } - } - } - }, - "type": "object" - }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", - "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": { - "description": "Payment transactions for the order", - "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": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "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": { - "description": "Tags assigned to the order for organization and filtering", - "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" - } + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "createdBy": { + "language": { "properties": { "links": { "type": "object", @@ -67777,7 +71957,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, @@ -67786,19 +71966,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "updatedBy": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -67806,7 +71986,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, @@ -67815,12 +71995,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -67835,307 +72015,85 @@ } ] }, - "Order": { + "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "billingAddressId", - "currencyId", + "email", + "status", + "hash", "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding" + "salesChannelId" ], "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": { - "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}$" - }, - "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 - }, - "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", - "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": { - "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.", + "email": { + "description": "Email of the recipient.", "type": "string" }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", + "firstName": { + "description": "First name of the recipient.", "type": "string" }, - "customerComment": { - "description": "Comments given by comments.", + "lastName": { + "description": "Last name of the recipient.", "type": "string" }, - "internalComment": { + "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, - "source": { - "description": "Source of orders either via normal order placement or subscriptions.", + "city": { + "description": "City of the recipient.", "type": "string" }, - "taxCalculationType": { + "street": { + "description": "Street of the recipient.", "type": "string" }, - "stateId": { - "description": "Unique identity of state.", + "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, - "ruleIds": { - "type": "array", - "items": { - "type": "string" - } + "hash": { + "description": "Password hash for account recovery.", + "type": "string" }, "customFields": { "type": "object" }, - "createdById": { - "description": "Unique identity of createdBy.", + "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "updatedById": { - "description": "Unique identity of updatedBy.", + "salutationId": { + "description": "Unique identity of salutation.", "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" + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -68147,427 +72105,237 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "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": { - "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}$" }, - "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" + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" }, - "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" + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" }, - "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" + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" }, - "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" + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "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" + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" + "createdByUserId": { + "description": "Unique identity of createdByUser.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quote": { - "properties": { - "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "organization": { + "relationships": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" - } - } - }, - "data": { - "type": "object", + "createdByIntegration": { "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + } + } }, - "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": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "4698501400b26be8a41def09646e1b59" + } + } } - } + }, + "type": "object" }, - "data": { - "type": "object", + "createdByUser": { "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + } + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" + "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}$" }, - "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", - "description": "Customer information associated with the order" - }, - "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" + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" }, - "addresses": { - "description": "All addresses associated with the order (billing and shipping)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Billing address for the order" + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" }, - "deliveries": { - "description": "Delivery information including shipping address and tracking", + "requiredPrivileges": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "type": "object", + "additionalProperties": false } }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "transactions": { - "description": "Payment transactions for the order", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } + "createdByUserId": { + "description": "Unique identity of createdByUser.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "createdBy": { - "$ref": "#/components/schemas/User" + "createdByIntegration": { + "$ref": "#/components/schemas/Integration" }, - "updatedBy": { + "createdByUser": { "$ref": "#/components/schemas/User" } }, "type": "object" }, - "OrderAddressJsonApi": { + "NumberRangeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -68576,102 +72344,44 @@ { "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "typeId", + "global", + "pattern", + "start", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "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 state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", + "typeId": { + "description": "Unique identity of type.", "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" + "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" }, - "phoneNumber": { - "description": "Phone number of the customer.", + "name": { "type": "string" }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", + "description": { "type": "string" }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", + "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "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" }, - "vatId": { - "description": "Unique identity of VAT.", - "type": "string", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -68682,9 +72392,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "country": { + "type": { "properties": { "links": { "type": "object", @@ -68692,7 +72405,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, @@ -68701,19 +72414,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "countryState": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -68721,7 +72434,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" + "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" } } }, @@ -68730,19 +72474,141 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" - }, - "order": { + } + }, + "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": { + "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": { + "type": "string" + }, + "description": { + "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" + }, + "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": { + "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 + }, + "relationships": { + "properties": { + "numberRange": { "properties": { "links": { "type": "object", @@ -68750,7 +72616,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, @@ -68759,19 +72625,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, - "orderDeliveries": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -68779,30 +72645,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery" - }, - "id": { - "type": "string", - "example": "0ba472de56dd7ba2e7bb878434321e26" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "salutation": { + "numberRangeType": { "properties": { "links": { "type": "object", @@ -68810,7 +72674,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, @@ -68819,12 +72683,12 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "3d771a402fc5aa3349c2c15637058e8c" } } } @@ -68839,105 +72703,150 @@ } ] }, - "OrderAddress": { + "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "numberRangeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", + "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "description": "Unique identity of state.", + "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "description": "Unique identity of order.", + "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "salutationId": { - "description": "Unique identity of salutation.", + "updatedAt": { "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" + "format": "date-time", + "readOnly": true }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", - "type": "string" + "numberRange": { + "$ref": "#/components/schemas/NumberRange" }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", - "type": "string" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "numberRangeType": { + "$ref": "#/components/schemas/NumberRangeType" + } + }, + "type": "object" + }, + "NumberRangeStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "customFields": { + { + "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", + "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}$" }, - "vatId": { - "description": "Unique identity of VAT.", + "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", - "deprecated": true + "pattern": "^[0-9a-f]{32}$" + }, + "lastValue": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -68949,28 +72858,13 @@ "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" + "numberRange": { + "$ref": "#/components/schemas/NumberRange" } }, "type": "object" }, - "OrderCustomerJsonApi": { + "NumberRangeTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -68979,76 +72873,28 @@ { "required": [ "id", - "orderId", - "email", - "firstName", - "lastName" + "global", + "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "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}$" - }, - "orderVersionId": { - "type": "string", - "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.", + "technicalName": { + "description": "Name of the number range type.", "type": "string" }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "typeName": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customerNumber": { - "description": "Unique number assigned to the customer.", - "type": "string" + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -69059,38 +72905,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "numberRanges": { "properties": { "links": { "type": "object", @@ -69098,28 +72918,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" } } }, "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" + }, + "id": { + "type": "string", + "example": "d28d88efea70a67487116019cff39002" + } } } } }, "type": "object" }, - "salutation": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -69127,21 +72949,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" } } }, "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": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } } } } @@ -69156,80 +72980,32 @@ } ] }, - "OrderCustomer": { + "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "email", - "firstName", - "lastName" + "global", + "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "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}$" - }, - "orderVersionId": { - "type": "string", - "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.", + "technicalName": { + "description": "Name of the number range type.", "type": "string" }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "typeName": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customerNumber": { - "description": "Unique number assigned to the customer.", - "type": "string" + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -69240,19 +73016,25 @@ "format": "date-time", "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" + "translated": { + "type": "object" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "numberRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } } }, "type": "object" }, - "OrderDeliveryJsonApi": { + "OrderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -69261,12 +73043,15 @@ { "required": [ "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", "stateId", - "shippingDateEarliest", - "shippingDateLatest" + "itemRounding", + "totalRounding" ], "properties": { "id": { @@ -69277,110 +73062,285 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "description": "Unique identity of order.", + "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}$" }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingOrderAddressVersionId": { + "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}$" }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", - "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", + "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": { + "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}$" }, - "trackingCodes": { + "ruleIds": { "type": "array", "items": { "type": "string" } }, - "shippingDateEarliest": { - "description": "Date and time of earliest delivery of products.", + "customFields": { + "type": "object" + }, + "createdById": { + "description": "Unique identity of createdBy.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products.", + "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "shippingCosts": { + "itemRounding": { "required": [ - "unitPrice", - "totalPrice", - "quantity" + "decimals", + "interval", + "roundForNet" ], "properties": { - "unitPrice": { - "type": "number", - "format": "float" + "decimals": { + "type": "integer", + "format": "int64" }, - "totalPrice": { + "interval": { "type": "number", "format": "float" }, - "quantity": { + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { "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" + "interval": { + "type": "number", + "format": "float" }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -69391,10 +73351,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "stateMachineState": { - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", + "salesChannelTracking": { "properties": { "links": { "type": "object", @@ -69402,7 +73361,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" } } }, @@ -69411,19 +73370,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "sales_channel_tracking_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" }, - "order": { + "subscription": { "properties": { "links": { "type": "object", @@ -69431,7 +73390,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" } } }, @@ -69440,20 +73399,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, - "shippingOrderAddress": { - "description": "Shipping address for this delivery", + "initialSubscriptions": { "properties": { "links": { "type": "object", @@ -69461,29 +73419,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" + "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_address" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "39a8592767b8b6a5d6b1dbc47e4058ca" + "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" }, - "shippingMethod": { - "description": "Shipping method used for this delivery", + "warehouseGroups": { "properties": { "links": { "type": "object", @@ -69491,29 +73481,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + "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": { - "type": { + "related": { "type": "string", - "example": "shipping_method" - }, - "id": { + "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": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "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" }, - "positions": { - "description": "Line items included in this delivery", + "orderEmployee": { "properties": { "links": { "type": "object", @@ -69521,7 +73574,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" } } }, @@ -69532,11 +73585,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "b2b_order_employee" }, "id": { "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" + "example": "5ea451c08a87db806089c4031601c29a" } } } @@ -69544,7 +73597,7 @@ }, "type": "object" }, - "primaryOrder": { + "quote": { "properties": { "links": { "type": "object", @@ -69552,7 +73605,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" } } }, @@ -69561,277 +73614,103 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f3654baea1bb37cbbd3b86e9793c3766" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "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": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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": [ - "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", - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Shipping address for this delivery" - }, - "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" - }, - "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": { - "description": "Unique identity of order delivery.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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}$" - }, - "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": { + "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" }, - "listPrice": { + "organization": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } } }, "type": "object" }, - "regulationPrice": { + "budget": { "properties": { - "price": { - "type": "number", - "format": "float" + "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" + } + } } }, "type": "object" @@ -69839,37 +73718,10 @@ }, "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" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, "relationships": { "properties": { - "orderDelivery": { + "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -69877,7 +73729,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" } } }, @@ -69886,19 +73738,20 @@ "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": { + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", @@ -69906,7 +73759,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" } } }, @@ -69915,363 +73768,50 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" } } } }, "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": { - "description": "Unique identity of order delivery.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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}$" - }, - "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": { - "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" - }, - "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", - "price", - "children", - "states" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "description": "Unique identity of product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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", - "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": { + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } } }, "type": "object" }, - "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", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "container", - "discount", - "quantity" - ] - }, - "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": { + "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -70279,30 +73819,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e90c9c228c1510f5a25902f7a1e8426a" } } } }, "type": "object" }, - "state": { + "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -70310,7 +73849,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" } } }, @@ -70319,25 +73858,20 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "cover": { - "description": "Line item image or thumbnail", + }, + "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -70345,7 +73879,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" } } }, @@ -70354,19 +73888,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "order": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -70374,7 +73908,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" } } }, @@ -70383,20 +73917,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "product": { - "description": "Referenced product if this is a product line item", + "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -70404,7 +73938,39 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" + "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": { + "description": "Billing address for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" } } }, @@ -70413,19 +73979,20 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" }, - "promotion": { + "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -70433,29 +74000,63 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" + "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": { + "description": "Order line items (products, discounts, fees)", + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "promotion" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "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" }, - "orderDeliveryPositions": { - "description": "Delivery positions for this line item", + "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -70463,7 +74064,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" } } }, @@ -70474,11 +74075,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "order_transaction" }, "id": { "type": "string", - "example": "76d4619a36f864b08f57415baaa685ec" + "example": "c15b977dd99332ca8623fbdfb86827e8" } } } @@ -70486,7 +74087,8 @@ }, "type": "object" }, - "orderTransactionCaptureRefundPositions": { + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -70494,7 +74096,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" } } }, @@ -70505,11 +74107,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund_position" + "example": "document" }, "id": { "type": "string", - "example": "c330b64e5adc1e48e07a78aa79e5b27a" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -70517,8 +74119,8 @@ }, "type": "object" }, - "downloads": { - "description": "Digital downloads associated with this line item", + "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -70526,7 +74128,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" } } }, @@ -70537,11 +74139,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "tag" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -70549,7 +74151,7 @@ }, "type": "object" }, - "parent": { + "createdBy": { "properties": { "links": { "type": "object", @@ -70557,7 +74159,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" } } }, @@ -70566,19 +74168,19 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "children": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -70586,23 +74188,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -70617,17 +74217,19 @@ } ] }, - "OrderLineItem": { + "Order": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "identifier", - "quantity", - "label", - "price", - "children", - "states" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding" ], "properties": { "id": { @@ -70638,80 +74240,126 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "description": "Unique identity of order.", + "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": { - "description": "Unique identity of product.", + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { - "description": "Unique identity of product.", + "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": { - "description": "Unique identity of cover image.", + "languageId": { + "description": "Unique identity of the language.", "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" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "description": "Number of items of product.", - "type": "integer", - "format": "int64" + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" }, - "label": { - "description": "It is a typical product name given to the line item.", - "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": { - "description": "When set to true, it indicates the line item is physical else it is virtual.", - "type": "boolean" + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "removable": { - "description": "Allows the line item to be removable from the cart when set to true.", - "type": "boolean" + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "stackable": { - "description": "Allows to change the quantity of the line item when set to true.", - "type": "boolean" + "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 }, - "position": { - "description": "Position of line items placed in an order.", - "type": "integer", - "format": "int64" + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true }, - "price": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -70722,105 +74370,441 @@ "type": "number", "format": "float" }, - "totalPrice": { - "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": { + "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}$" + }, + "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", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, + "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" }, - "quantity": { - "type": "integer", - "format": "int64" + "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" }, - "calculatedTaxes": { + "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" }, - "taxRules": { + "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" }, - "referencePrice": { + "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" }, - "listPrice": { + "returns": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + } + } }, - "discount": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, + "type": "object" + }, + "orderEmployee": { + "properties": { + "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": { - "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", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "container", - "discount", - "quantity" - ] - }, - "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": { + }, + "b2bPendingOrder": { "properties": { "links": { "type": "object", @@ -70828,7 +74812,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" } } }, @@ -70839,11 +74823,11 @@ "properties": { "type": { "type": "string", - "example": "order_return_line_item" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "7fff84525c6516919851a9005373f87e" + "example": "c7e0572188e2dec59215e8872024567e" } } } @@ -70851,7 +74835,7 @@ }, "type": "object" }, - "state": { + "organization": { "properties": { "links": { "type": "object", @@ -70859,7 +74843,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" } } }, @@ -70868,12 +74852,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" } } } @@ -70883,54 +74896,90 @@ }, "type": "object" }, - "cover": { - "$ref": "#/components/schemas/Media", - "description": "Line item image or thumbnail" + "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", - "description": "Referenced product if this is a product line item" + "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": { - "description": "Delivery positions for this line item", + "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": { - "description": "Digital downloads associated with this line item", + "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" @@ -70938,10 +74987,12 @@ { "required": [ "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -70952,32 +75003,86 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", + "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": { - "description": "Unique identity of media.", + "orderId": { + "description": "Unique identity of order.", "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" + "orderVersionId": { + "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" + }, + "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" }, - "accessGranted": { - "description": "When boolean value is `true`, the digital product is allowed to download.", - "type": "boolean" + "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", @@ -70990,7 +75095,7 @@ }, "relationships": { "properties": { - "orderLineItem": { + "country": { "properties": { "links": { "type": "object", @@ -70998,7 +75103,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, @@ -71007,19 +75112,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", @@ -71027,7 +75132,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" } } }, @@ -71036,12 +75141,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" } } } @@ -71056,14 +75250,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": { @@ -71074,32 +75270,86 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", + "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": { - "description": "Unique identity of media.", + "orderId": { + "description": "Unique identity of order.", "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" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessGranted": { - "description": "When boolean value is `true`, the digital product is allowed to download.", - "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", @@ -71110,16 +75360,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" @@ -71128,8 +75391,9 @@ "required": [ "id", "orderId", - "productId", - "warehouseId" + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -71140,29 +75404,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", @@ -71184,7 +75480,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, @@ -71205,7 +75501,7 @@ }, "type": "object" }, - "product": { + "customer": { "properties": { "links": { "type": "object", @@ -71213,7 +75509,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, @@ -71222,19 +75518,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "warehouse": { + "salutation": { "properties": { "links": { "type": "object", @@ -71242,7 +75538,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, @@ -71251,12 +75547,12 @@ "properties": { "type": { "type": "string", - "example": "warehouse" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "372d30dd2849813ef674855253900679" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -71271,12 +75567,14 @@ } ] }, - "OrderProductWarehouse": { + "OrderCustomer": { + "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", - "productId", - "warehouseId" + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -71287,29 +75585,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", @@ -71324,16 +75654,17 @@ "order": { "$ref": "#/components/schemas/Order" }, - "product": { - "$ref": "#/components/schemas/Product" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "warehouse": { - "$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" @@ -71342,9 +75673,11 @@ "required": [ "id", "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "returnNumber", - "requestedAt" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -71356,6 +75689,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71363,42 +75697,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": [ @@ -71457,35 +75789,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", @@ -71499,7 +75804,8 @@ }, "relationships": { "properties": { - "order": { + "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -71507,7 +75813,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" } } }, @@ -71516,19 +75822,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", @@ -71536,7 +75842,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" } } }, @@ -71545,19 +75851,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", @@ -71565,7 +75872,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/createdBy" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" } } }, @@ -71574,19 +75881,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", @@ -71594,7 +75902,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" } } }, @@ -71603,19 +75911,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", @@ -71623,7 +75932,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" } } }, @@ -71634,17 +75943,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" @@ -71654,13 +75992,16 @@ } ] }, - "OrderReturn": { + "OrderDelivery": { + "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "returnNumber", - "requestedAt" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -71672,6 +76013,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71679,42 +76021,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": [ @@ -71773,35 +76113,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", @@ -71813,28 +76126,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" @@ -71842,12 +76163,8 @@ { "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -71858,15 +76175,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}$" }, @@ -71874,14 +76193,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "price": { "required": [ "unitPrice", @@ -71939,24 +76250,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", @@ -71969,65 +76280,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", @@ -72035,7 +76288,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, @@ -72044,19 +76297,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", @@ -72064,7 +76317,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" } } }, @@ -72078,7 +76331,7 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "867cf1ff92974922abc5d5b045b4a2d8" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } @@ -72093,15 +76346,12 @@ } ] }, - "OrderReturnLineItem": { + "OrderDeliveryPosition": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -72112,15 +76362,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}$" }, @@ -72128,14 +76380,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "price": { "required": [ "unitPrice", @@ -72193,24 +76437,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", @@ -72221,167 +76465,16 @@ "format": "date-time", "readOnly": true }, - "reason": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "return": { - "$ref": "#/components/schemas/OrderReturn" + "orderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" }, - "lineItem": { + "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, - "OrderReturnLineItemReasonJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "reasonKey" - ], - "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" - ], - "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}$" - }, - "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": { + "OrderLineItemJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -72391,9 +76484,12 @@ "required": [ "id", "orderId", - "paymentMethodId", - "amount", - "stateId" + "identifier", + "quantity", + "label", + "price", + "children", + "states" ], "properties": { "id": { @@ -72405,7 +76501,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { - "description": "Unique identity of an order.", + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -72413,12 +76509,71 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "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", @@ -72475,17 +76630,46 @@ }, "type": "object" }, - "validationData": { + "priceDefinition": { "type": "object" }, - "stateId": { - "description": "Unique identity of state.", + "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", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -72496,10 +76680,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "stateMachineState": { - "description": "Current payment transaction state (e.g., open, paid, cancelled)", + "returns": { "properties": { "links": { "type": "object", @@ -72507,7 +76690,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" } } }, @@ -72521,7 +76735,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" } } } @@ -72536,7 +76785,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" } } }, @@ -72557,8 +76806,8 @@ }, "type": "object" }, - "paymentMethod": { - "description": "Payment method used for this transaction", + "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -72566,7 +76815,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" } } }, @@ -72575,20 +76824,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": { - "description": "Payment captures for this transaction", + "promotion": { "properties": { "links": { "type": "object", @@ -72596,7 +76844,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" } } }, @@ -72607,11 +76885,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "order_delivery_position" }, "id": { "type": "string", - "example": "8856ffdd044d57cd4124a6be5dcea329" + "example": "76d4619a36f864b08f57415baaa685ec" } } } @@ -72619,7 +76897,7 @@ }, "type": "object" }, - "primaryOrder": { + "orderTransactionCaptureRefundPositions": { "properties": { "links": { "type": "object", @@ -72627,7 +76905,70 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + "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" } } }, @@ -72636,12 +76977,43 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f3654baea1bb37cbbd3b86e9793c3766" + "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" + } } } } @@ -72656,14 +77028,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": { @@ -72675,7 +77050,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { - "description": "Unique identity of an order.", + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -72683,12 +77058,71 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "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", @@ -72745,17 +77179,46 @@ }, "type": "object" }, - "validationData": { + "priceDefinition": { "type": "object" }, - "stateId": { - "description": "Unique identity of state.", + "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", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -72766,32 +77229,119 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current payment transaction state (e.g., open, paid, cancelled)" + "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": { + "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" + } + }, + "type": "object" + }, + "cover": { + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Payment method used for this transaction" + "product": { + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, - "captures": { - "description": "Payment captures for this transaction", + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderDeliveryPosition" } }, - "primaryOrder": { - "$ref": "#/components/schemas/Order" + "orderTransactionCaptureRefundPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + }, + "downloads": { + "description": "Digital downloads associated with this line item", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + }, + "parent": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "children": { + "type": "array", + "items": { + "$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" @@ -72799,9 +77349,10 @@ { "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "orderLineItemId", + "mediaId", + "position", + "accessGranted" ], "properties": { "id": { @@ -72812,80 +77363,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "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": { - "description": "Unique identity of order state.", + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "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" @@ -72902,7 +77401,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -72910,7 +77409,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" } } }, @@ -72919,19 +77418,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", @@ -72939,7 +77438,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" } } }, @@ -72948,43 +77447,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" } } } @@ -72999,13 +77467,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": { @@ -73016,80 +77485,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "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": { - "description": "Unique identity of order state.", + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "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" @@ -73104,23 +77521,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" @@ -73128,9 +77538,9 @@ { "required": [ "id", - "captureId", - "stateId", - "amount" + "orderId", + "productId", + "warehouseId" ], "properties": { "id": { @@ -73141,87 +77551,29 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of order state.", + "productId": { "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" + "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", @@ -73235,7 +77587,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "order": { "properties": { "links": { "type": "object", @@ -73243,7 +77595,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" } } }, @@ -73252,19 +77604,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", @@ -73272,7 +77624,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" } } }, @@ -73281,19 +77633,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", @@ -73301,135 +77653,74 @@ "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" - } + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" } - } - } - }, - "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" + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "372d30dd2849813ef674855253900679" + } + } + } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "OrderProductWarehouse": { + "required": [ + "id", + "orderId", + "productId", + "warehouseId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "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}$" + }, + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -73441,23 +77732,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" @@ -73465,9 +77752,10 @@ { "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { @@ -73478,38 +77766,52 @@ "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.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "orderVersionId": { "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" + "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", @@ -73566,8 +77868,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", @@ -73581,7 +77910,7 @@ }, "relationships": { "properties": { - "orderLineItem": { + "order": { "properties": { "links": { "type": "object", @@ -73589,7 +77918,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" } } }, @@ -73598,19 +77927,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", @@ -73618,7 +77947,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" } } }, @@ -73627,12 +77956,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" + } } } } @@ -73647,13 +78065,13 @@ } ] }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", + "OrderReturn": { "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { @@ -73664,38 +78082,52 @@ "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.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "orderVersionId": { "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" + "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", @@ -73742,172 +78174,43 @@ }, "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", - "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": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" }, - "versionId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "returnNumber": { + "type": "string" + }, + "requestedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "orderVersionId": { + "amountTotal": { + "type": "number", + "format": "float" + }, + "amountNet": { + "type": "number", + "format": "float" + }, + "internalComment": { + "type": "string" + }, + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "warehouseGroupId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -73924,14 +78227,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" @@ -73939,206 +78253,96 @@ { "required": [ "id", - "technicalName", - "name" + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { - "description": "Unique identity of plugin.", + "versionId": { "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.", + "orderReturnId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "description": "Unique identity of media.", + "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 - }, - "technicalName": { - "type": "string" - }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", - "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": { - "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" - } - } - } - } - }, + "taxRules": { "type": "object" }, - "organizations": { + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "d9811f03b461a380c0d6b4a497dbac37" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "b2bPendingOrders": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" @@ -74146,10 +78350,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": { - "description": "Payment method logo or icon image", + "reason": { "properties": { "links": { "type": "object", @@ -74157,7 +78388,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" } } }, @@ -74166,19 +78397,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", @@ -74186,7 +78417,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" } } }, @@ -74195,50 +78426,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", @@ -74246,7 +78446,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" } } }, @@ -74255,19 +78455,19 @@ "properties": { "type": { "type": "string", - "example": "plugin" + "example": "order_return" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "a24bcf2198b1b13ad985304483f7f324" + "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" } } } }, "type": "object" }, - "customers": { + "lineItem": { "properties": { "links": { "type": "object", @@ -74275,61 +78475,215 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" } } }, "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": { "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" - } + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "867cf1ff92974922abc5d5b045b4a2d8" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderReturnLineItem": { + "required": [ + "id", + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "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" }, - "salesChannels": { + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "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" + ], + "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", @@ -74337,7 +78691,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" + "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" } } }, @@ -74348,46 +78702,17 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "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" @@ -74397,73 +78722,20 @@ } ] }, - "PaymentMethod": { - "description": "Added since version: 6.0.0.0", + "OrderReturnLineItemReason": { "required": [ "id", - "technicalName", - "name" + "reasonKey" ], "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": { + "reasonKey": { "type": "string" }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", + "content": { "type": "string" }, "createdAt": { @@ -74479,176 +78751,48 @@ "translated": { "type": "object" }, - "extensions": { - "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" - } - } - } - } - }, - "type": "object" - }, - "quoteTransactions": { - "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" - } - } - } - } - }, - "type": "object" - }, - "organizations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/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": "/payment-method/da8da1569e6bef3249a7064261df833f/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" - }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Payment method logo or icon image" - }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" - }, - "salesChannelDefaultAssignments": { + "lineItems": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$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}$" }, - "plugin": { - "$ref": "#/components/schemas/Plugin" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderTransactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "order": { + "$ref": "#/components/schemas/Order" }, - "appPaymentMethod": { - "$ref": "#/components/schemas/AppPaymentMethod" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "PluginJsonApi": { + "OrderTransactionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -74657,90 +78801,98 @@ { "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "orderId", + "paymentMethodId", + "amount", + "stateId" ], "properties": { "id": { "type": "string", "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.", + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "upgradedAt": { - "description": "Date and time when the plugin was upgraded.", + "orderId": { + "description": "Unique identity of an order.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderVersionId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "label": { - "type": "string" + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "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" }, - "manufacturerLink": { - "type": "string" + "validationData": { + "type": "object" }, - "supportLink": { - "type": "string" + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -74755,12 +78907,10 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "paymentMethods": { + "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -74768,7 +78918,96 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + "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": { + "description": "Payment method used for this transaction", + "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": { + "description": "Payment captures for this transaction", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" } } }, @@ -74779,17 +79018,46 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "order_transaction_capture" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "8856ffdd044d57cd4124a6be5dcea329" } } } } }, "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" @@ -74799,460 +79067,240 @@ } ] }, - "Plugin": { + "OrderTransaction": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "orderId", + "paymentMethodId", + "amount", + "stateId" ], "properties": { "id": { "type": "string", "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.", + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderId": { + "description": "Unique identity of an order.", "type": "string", - "readOnly": true - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "manufacturerLink": { - "type": "string" - }, - "supportLink": { - "type": "string" - }, - "customFields": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "paymentMethodId": { + "description": "Unique identity of payment method.", "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" + "pattern": "^[0-9a-f]{32}$" }, - { - "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": { - "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" - }, - "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" - }, - "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": { - "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 + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "totalPrice": { + "type": "number", + "format": "float" }, - "childCount": { + "quantity": { "type": "integer", - "format": "int64", - "readOnly": true + "format": "int64" }, - "customFieldSetSelectionActive": { - "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", - "type": "boolean" + "calculatedTaxes": { + "type": "object" }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true + "taxRules": { + "type": "object" }, - "metaDescription": { - "type": "string" + "referencePrice": { + "type": "object" }, - "name": { - "type": "string" + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "keywords": { - "type": "string" + "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}$" }, - "description": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "metaTitle": { - "type": "string" + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "packUnit": { - "type": "string" + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "packUnitPlural": { + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", "type": "string" }, - "customFields": { + "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" }, - "slotConfig": { + "customFields": { "type": "object" }, - "customSearchKeywords": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -75263,12 +79311,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { + "relationships": { "properties": { - "customPrice": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -75276,61 +79321,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/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": { + "transaction": { "properties": { "links": { "type": "object", @@ -75338,30 +79350,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, "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_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, - "warehouses": { + "refunds": { "properties": { "links": { "type": "object", @@ -75369,7 +79379,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, @@ -75380,203 +79390,240 @@ "properties": { "type": { "type": "string", - "example": "product_warehouse" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", - "example": "544959798565126142ca2820b4f56271" + "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" + }, + "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" }, - "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" + "totalPrice": { + "type": "number", + "format": "float" }, - "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" + "quantity": { + "type": "integer", + "format": "int64" }, - "search": { + "calculatedTaxes": { "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" - } - } - } - } - }, + "taxRules": { "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" - } - } - } - } - }, + "referencePrice": { "type": "object" }, - "employeeWishlists": { + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_employee_wishlist_product" - }, - "id": { - "type": "string", - "example": "e91afc4e24376c8b995cece3ce354b4e" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "individualPricings": { + "regulationPrice": { "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" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" @@ -75584,10 +79631,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": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "stateMachineState": { "properties": { "links": { "type": "object", @@ -75595,31 +79654,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/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": { - "description": "Unique identity of the product.", + "transactionCapture": { "properties": { "links": { "type": "object", @@ -75627,7 +79683,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, @@ -75636,20 +79692,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction_capture" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "56b70ce76ce8e9bfbaf80ea040d456b5" } } } }, "type": "object" }, - "children": { - "description": "Product variants that inherit from this parent product", + "positions": { "properties": { "links": { "type": "object", @@ -75657,7 +79712,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" } } }, @@ -75668,199 +79723,276 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "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" }, - "deliveryTime": { - "description": "Estimated delivery time for the product", - "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" + "discount": { + "type": "number", + "format": "float" }, - "tax": { - "description": "Tax configuration (rate and calculation rules)", - "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" - } - } - } - }, + "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" }, - "manufacturer": { - "description": "Product manufacturer or brand information", - "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" - } - } - } - }, + "taxRules": { "type": "object" }, - "unit": { - "description": "Product unit of measure (e.g., piece, liter, kg)", - "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" - } - } - } - }, + "referencePrice": { "type": "object" }, - "cover": { - "description": "Main product image displayed in listings and detail pages", + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "featureSet": { + "regulationPrice": { "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" - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "cmsPage": { - "description": "Custom CMS page layout for the product detail page", + } + }, + "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", @@ -75868,7 +80000,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, @@ -75877,20 +80009,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "canonicalProduct": { - "description": "Canonical product reference for variant consolidation and SEO purposes", + "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", @@ -75898,7 +80029,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, @@ -75907,177 +80038,198 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction_capture_refund" }, "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": { - "description": "Product images and media gallery", - "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": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "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": "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" }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", - "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" + "discount": { + "type": "number", + "format": "float" }, - "visibilities": { + "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", @@ -76085,30 +80237,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/visibilities" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_visibility" - }, - "id": { - "type": "string", - "example": "63226fcdfe3316ec1237ef07a8fe6732" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "searchKeywords": { + "warehouseGroup": { "properties": { "links": { "type": "object", @@ -76116,31 +80266,171 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_search_keyword" - }, - "id": { - "type": "string", - "example": "effbcffaacb8111b531f15e6f4c796d1" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1768e3071b62161d415e0c24332055ed" } } } }, "type": "object" - }, - "productReviews": { - "description": "Customer reviews and ratings for the product", + } + }, + "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", @@ -76148,7 +80438,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/productReviews" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, @@ -76159,11 +80449,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "subscription" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -76171,8 +80461,7 @@ }, "type": "object" }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", + "quoteTransactions": { "properties": { "links": { "type": "object", @@ -76180,7 +80469,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/mainCategories" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, @@ -76191,11 +80480,11 @@ "properties": { "type": { "type": "string", - "example": "main_category" + "example": "quote_transaction" }, "id": { "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } @@ -76203,8 +80492,7 @@ }, "type": "object" }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", + "organizations": { "properties": { "links": { "type": "object", @@ -76212,7 +80500,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/seoUrls" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, @@ -76223,11 +80511,11 @@ "properties": { "type": { "type": "string", - "example": "seo_url" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -76235,7 +80523,7 @@ }, "type": "object" }, - "orderLineItems": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -76243,7 +80531,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, @@ -76254,19 +80542,25 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" - }, - "wishlists": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -76274,31 +80568,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/wishlists" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_wishlist_product" - }, - "id": { - "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", + "availabilityRule": { "properties": { "links": { "type": "object", @@ -76306,31 +80597,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/options" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" } } }, "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": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "properties": { - "description": "Product properties and characteristics for filtering", + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -76338,7 +80626,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/properties" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" } } }, @@ -76349,11 +80637,11 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "sales_channel" }, "id": { "type": "string", - "example": "74693d2fc58b46bd06410f278e39aa71" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -76361,8 +80649,7 @@ }, "type": "object" }, - "categories": { - "description": "Categories this product is assigned to", + "plugin": { "properties": { "links": { "type": "object", @@ -76370,31 +80657,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categories" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "plugin" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a24bcf2198b1b13ad985304483f7f324" } } } }, "type": "object" }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", + "customers": { "properties": { "links": { "type": "object", @@ -76402,7 +80686,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/streams" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" } } }, @@ -76413,11 +80697,11 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "customer" }, "id": { "type": "string", - "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -76425,8 +80709,7 @@ }, "type": "object" }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", + "orderTransactions": { "properties": { "links": { "type": "object", @@ -76434,7 +80717,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" } } }, @@ -76445,11 +80728,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "order_transaction" }, "id": { "type": "string", - "example": "7f0702d3a90d965b8c9158c451f43fdb" + "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } @@ -76457,8 +80740,7 @@ }, "type": "object" }, - "tags": { - "description": "Tags for organizing and filtering products", + "salesChannels": { "properties": { "links": { "type": "object", @@ -76466,7 +80748,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tags" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" } } }, @@ -76477,11 +80759,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "sales_channel" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -76489,7 +80771,7 @@ }, "type": "object" }, - "customFieldSets": { + "appPaymentMethod": { "properties": { "links": { "type": "object", @@ -76497,372 +80779,104 @@ "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" - } + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" } - } - } - }, - "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": { - "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" - }, - "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": { + } + }, + "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", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "variantRestrictions": { - "type": "object" + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, - "ean": { - "description": "Indicates EAN of the product.", + "name": { "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" + "distinguishableName": { + "type": "string", + "readOnly": true }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" + "description": { + "type": "string" }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", + "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": { - "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.", + "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": { - "description": "Indicates weather the product is top seller or not.", + "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": { - "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" + "customFields": { + "type": "object" }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "availabilityRuleId": { + "description": "Unique identity of rule.", "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 + "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetSelectionActive": { - "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", - "type": "boolean" + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", "readOnly": true }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "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 - } - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -76878,7 +80892,7 @@ }, "extensions": { "properties": { - "customPrice": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -76886,7 +80900,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, @@ -76897,11 +80911,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "subscription" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -76909,7 +80923,7 @@ }, "type": "object" }, - "subscriptionPlans": { + "quoteTransactions": { "properties": { "links": { "type": "object", @@ -76917,7 +80931,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, @@ -76928,11 +80942,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_plan" + "example": "quote_transaction" }, "id": { "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" + "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } @@ -76940,7 +80954,7 @@ }, "type": "object" }, - "warehouseGroups": { + "organizations": { "properties": { "links": { "type": "object", @@ -76948,7 +80962,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, @@ -76959,11 +80973,11 @@ "properties": { "type": { "type": "string", - "example": "warehouse_group" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -76971,7 +80985,7 @@ }, "type": "object" }, - "warehouses": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -76979,7 +80993,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, @@ -76990,383 +81004,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" - } - } - } - } - }, - "type": "object" + "name": { + "description": "Unique name of the plugin.", + "type": "string" }, - "search": { - "type": "object" + "composerName": { + "description": "Name of the composer package name.", + "type": "string" }, - "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" - } - } - } - } - }, + "autoload": { "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" - } - } - } - } - }, + "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" }, - "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" - } - } - } - } - }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" }, - "individualPricings": { + "relationships": { "properties": { - "links": { - "type": "object", + "paymentMethods": { "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" + "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": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - }, - "parent": { - "$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", - "description": "Estimated delivery time for the product" - }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration (rate and calculation rules)" - }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer", - "description": "Product manufacturer or brand information" - }, - "unit": { - "$ref": "#/components/schemas/Unit", - "description": "Product unit of measure (e.g., piece, liter, kg)" + "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" }, - "cover": { - "$ref": "#/components/schemas/ProductMedia", - "description": "Main product image displayed in listings and detail pages" + "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", - "description": "Custom CMS page layout for the product detail page" + "autoload": { + "type": "object" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product", - "description": "Canonical product reference for variant consolidation and SEO purposes" + "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": { - "description": "Product images and media gallery", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "path": { + "description": "A relative URL to the plugin.", + "type": "string" }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "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": { - "description": "Variant configurator settings defining available options for product variants", - "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": { - "description": "Customer reviews and ratings for the product", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "installedAt": { + "description": "Date and time when the plugin was installed.", + "type": "string", + "format": "date-time" }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", + "type": "string", + "format": "date-time" }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "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": { - "description": "Product variant options (e.g., size, color) that define different variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "manufacturerLink": { + "type": "string" }, - "properties": { - "description": "Product properties and characteristics for filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "supportLink": { + "type": "string" }, - "categories": { - "description": "Categories this product is assigned to", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "customFields": { + "type": "object" }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } + "createdAt": { + "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" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "description": "Tags for organizing and filtering products", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "translated": { + "type": "object" }, - "customFieldSets": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/PaymentMethod" } } }, @@ -78366,6 +82318,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -78631,6 +82587,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -81533,7 +85493,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -81643,7 +85608,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -87598,6 +91568,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" @@ -88194,6 +92195,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" @@ -88769,6 +92801,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -90385,6 +94479,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -91470,6 +95626,298 @@ }, "type": "object" }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -92412,9 +96860,10 @@ "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", "enum": [ - "frontend.detail.page", "frontend.navigation.page", - "frontend.landing.page" + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" ] }, "pathInfo": { @@ -92560,9 +97009,10 @@ "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", "enum": [ - "frontend.detail.page", "frontend.navigation.page", - "frontend.landing.page" + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" ] }, "pathInfo": { @@ -104953,6 +109403,111 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -105171,271 +109726,40 @@ ], "additionalProperties": false }, - "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" - ] - }, - "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" - ] - } - ] - }, - "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" + } } } } }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } - } - }, "Criteria": { "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)", @@ -106142,6 +110466,156 @@ "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", @@ -106186,97 +110660,87 @@ } } }, - "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" - } - } - } - } - }, - "ConsentState": { + "Price": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], + "description": "Price object", "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { + "currencyId": { "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" + "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" + "gross": { + "description": "", + "type": "number" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "net": { + "description": "", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "linked": { + "description": "", + "type": "boolean" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "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" + ] }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" + "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" + ] }, "CustomPricingResponse": { "type": "object", @@ -106620,6 +111084,171 @@ "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": { @@ -107146,6 +111775,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" @@ -107610,6 +112251,14 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index ec53ba9..7228d8d 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/user/logout", "/_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", @@ -77,6 +78,8 @@ "/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", @@ -97,7 +100,6 @@ "/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", @@ -142,6 +144,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", @@ -158,6 +164,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", @@ -178,6 +189,10 @@ "/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", @@ -208,6 +223,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", @@ -226,6 +243,8 @@ "/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", @@ -380,6 +399,15 @@ "B2bOrderEmployeeJsonApi", "B2bPermission", "B2bPermissionJsonApi", + "BundleDiscount", + "BundleDiscountJsonApi", + "BundleDiscountRule", + "BundleItem", + "BundleItemJsonApi", + "BundleItemProduct", + "BundleProduct", + "BundleProductWrite", + "BundleVisibility", "Category", "CategoryJsonApi", "CategoryTag", @@ -667,6 +695,10 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", From d8d552ce41aaccc5393498c88a063c83a936aef2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Apr 2026 16:48:23 +0200 Subject: [PATCH 08/12] [create-pull-request] automated change (#469) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 3539 +++++++++++++----- SwagCustomizedProducts-adminapi.summary.json | 14 +- 2 files changed, 2645 insertions(+), 908 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 7945369..6287809 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -15,14 +15,15 @@ } ], "paths": { - "/swag-customized-products-template": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "List with basic information of Swag Customized Products Template resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", + "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { "name": "limit", @@ -51,7 +52,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template resources.", + "description": "List of Sales Channel Tracking Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70,7 +71,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } ] @@ -84,16 +85,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template?limit=25" + "example": "/sales-channel-tracking-customer?limit=25" }, "last": { - "example": "/swag-customized-products-template?limit=25&page=11" + "example": "/sales-channel-tracking-customer?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template?limit=25&page=4" + "example": "/sales-channel-tracking-customer?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" + "example": "/sales-channel-tracking-customer?limit=25&page=2" } } } @@ -114,7 +115,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -129,11 +130,12 @@ }, "post": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Create a new Swag Customized Products Template resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplate", + "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { "name": "_response", @@ -152,14 +154,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -171,7 +173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -186,7 +188,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -202,14 +204,15 @@ } } }, - "/search/swag-customized-products-template": { + "/search/sales-channel-tracking-customer": { "post": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Search for the Swag Customized Products Template resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", + "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -237,7 +240,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -251,7 +254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -269,7 +272,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -286,19 +289,20 @@ } } }, - "/swag-customized-products-template/{id}": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Detailed information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplate", + "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -308,7 +312,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -320,7 +324,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -335,7 +339,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -352,16 +356,17 @@ }, "delete": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Delete a Swag Customized Products Template resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", + "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -392,16 +397,17 @@ }, "patch": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Partially update information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", + "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -419,18 +425,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template resource.", + "description": "Partially update information about a Sales Channel Tracking Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -442,7 +448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -457,7 +463,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -476,14 +482,15 @@ } } }, - "/aggregate/swag-customized-products-template": { + "/aggregate/sales-channel-tracking-customer": { "post": { "tags": [ - "Swag Customized Products Template" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Aggregate for the Swag Customized Products Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplate", + "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingCustomer", "requestBody": { "required": true, "content": { @@ -507,7 +514,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -521,7 +528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -539,7 +546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -556,14 +563,15 @@ } } }, - "/swag-customized-products-template-configuration": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ { "name": "limit", @@ -592,7 +600,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration resources.", + "description": "List of Sales Channel Tracking Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -611,7 +619,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } ] @@ -625,16 +633,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration?limit=25" + "example": "/sales-channel-tracking-order?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" + "example": "/sales-channel-tracking-order?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" + "example": "/sales-channel-tracking-order?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" + "example": "/sales-channel-tracking-order?limit=25&page=2" } } } @@ -655,7 +663,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -670,11 +678,12 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { "name": "_response", @@ -693,14 +702,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -712,7 +721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -727,7 +736,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -743,14 +752,15 @@ } } }, - "/search/swag-customized-products-template-configuration": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { "name": "sw-include-search-info", @@ -778,7 +788,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -792,7 +802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -810,7 +820,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -827,19 +837,20 @@ } } }, - "/swag-customized-products-template-configuration/{id}": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -849,7 +860,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -861,7 +872,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -876,7 +887,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -893,16 +904,17 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -933,16 +945,17 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -960,18 +973,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "Partially update information about a Sales Channel Tracking Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -983,7 +996,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -998,7 +1011,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -1017,14 +1030,15 @@ } } }, - "/aggregate/swag-customized-products-template-configuration": { + "/aggregate/sales-channel-tracking-order": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { @@ -1048,7 +1062,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -1062,7 +1076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -1080,7 +1094,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -1097,14 +1111,14 @@ } } }, - "/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", @@ -1133,7 +1147,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": { @@ -1152,7 +1166,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] @@ -1166,16 +1180,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" } } } @@ -1196,7 +1210,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1211,11 +1225,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", @@ -1234,14 +1248,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": { @@ -1253,7 +1267,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1268,7 +1282,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1284,14 +1298,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", "parameters": [ { "name": "sw-include-search-info", @@ -1319,7 +1333,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -1333,7 +1347,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1351,7 +1365,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1368,19 +1382,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", @@ -1390,7 +1404,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -1402,7 +1416,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1417,7 +1431,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1434,16 +1448,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", @@ -1474,16 +1488,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", @@ -1501,18 +1515,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": { @@ -1524,7 +1538,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1539,7 +1553,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1558,14 +1572,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": { @@ -1589,7 +1603,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -1603,7 +1617,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1621,7 +1635,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -1638,14 +1652,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", @@ -1674,7 +1688,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": { @@ -1693,7 +1707,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] @@ -1707,16 +1721,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" } } } @@ -1737,7 +1751,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1752,11 +1766,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", @@ -1775,14 +1789,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": { @@ -1794,7 +1808,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1809,7 +1823,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1825,14 +1839,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", "parameters": [ { "name": "sw-include-search-info", @@ -1860,7 +1874,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -1874,7 +1888,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1892,7 +1906,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1909,19 +1923,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", @@ -1931,7 +1945,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -1943,7 +1957,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1958,7 +1972,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1975,16 +1989,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", @@ -2015,16 +2029,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", @@ -2042,18 +2056,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": { @@ -2065,7 +2079,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -2080,7 +2094,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -2099,14 +2113,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": { @@ -2130,7 +2144,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -2144,7 +2158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -2162,7 +2176,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -2179,14 +2193,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", @@ -2215,7 +2229,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": { @@ -2234,7 +2248,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] @@ -2248,16 +2262,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" } } } @@ -2278,7 +2292,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2293,11 +2307,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", @@ -2316,14 +2330,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": { @@ -2335,7 +2349,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2350,7 +2364,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2366,14 +2380,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", "parameters": [ { "name": "sw-include-search-info", @@ -2401,7 +2415,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -2415,7 +2429,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2433,7 +2447,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2450,19 +2464,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", @@ -2472,7 +2486,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -2484,7 +2498,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2499,7 +2513,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2516,16 +2530,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", @@ -2556,16 +2570,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", @@ -2583,18 +2597,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": { @@ -2606,7 +2620,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2621,7 +2635,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2640,14 +2654,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": { @@ -2671,7 +2685,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -2685,7 +2699,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2703,7 +2717,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -2720,14 +2734,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", @@ -2756,7 +2770,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": { @@ -2775,7 +2789,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] @@ -2789,16 +2803,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" } } } @@ -2819,7 +2833,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2834,11 +2848,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", @@ -2857,14 +2871,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": { @@ -2876,7 +2890,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2891,7 +2905,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2907,14 +2921,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", "parameters": [ { "name": "sw-include-search-info", @@ -2942,7 +2956,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -2956,7 +2970,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2974,7 +2988,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2991,19 +3005,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", @@ -3013,7 +3027,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -3025,7 +3039,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3040,7 +3054,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3057,16 +3071,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", @@ -3097,16 +3111,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", @@ -3124,18 +3138,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": { @@ -3147,7 +3161,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3162,7 +3176,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3181,14 +3195,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": { @@ -3212,7 +3226,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -3226,7 +3240,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3244,7 +3258,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -3261,14 +3275,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", @@ -3297,7 +3311,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": { @@ -3316,7 +3330,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] @@ -3330,16 +3344,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" } } } @@ -3360,7 +3374,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3375,11 +3389,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", @@ -3398,14 +3412,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": { @@ -3417,7 +3431,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3432,7 +3446,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3448,14 +3462,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", "parameters": [ { "name": "sw-include-search-info", @@ -3483,7 +3497,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3511,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3515,7 +3529,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3532,19 +3546,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", @@ -3554,7 +3568,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -3566,7 +3580,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3581,7 +3595,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3598,16 +3612,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", @@ -3638,16 +3652,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", @@ -3665,18 +3679,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": { @@ -3688,7 +3702,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3703,7 +3717,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3722,14 +3736,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": { @@ -3753,7 +3767,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -3767,7 +3781,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3785,7 +3799,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -3802,14 +3816,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", @@ -3838,7 +3852,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": { @@ -3857,7 +3871,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] @@ -3871,16 +3885,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" } } } @@ -3901,7 +3915,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3916,11 +3930,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", @@ -3939,14 +3953,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": { @@ -3958,7 +3972,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3973,7 +3987,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3989,14 +4003,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", "parameters": [ { "name": "sw-include-search-info", @@ -4024,7 +4038,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -4038,7 +4052,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4056,7 +4070,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4073,19 +4087,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", @@ -4095,7 +4109,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -4107,7 +4121,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4122,7 +4136,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4139,16 +4153,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", @@ -4179,16 +4193,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", @@ -4206,18 +4220,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": { @@ -4229,7 +4243,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4244,7 +4258,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4263,14 +4277,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": { @@ -4294,7 +4308,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -4308,7 +4322,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4326,7 +4340,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -4343,14 +4357,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", @@ -4379,7 +4393,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": { @@ -4398,7 +4412,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] @@ -4412,16 +4426,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" } } } @@ -4442,7 +4456,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4457,11 +4471,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", @@ -4480,14 +4494,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": { @@ -4499,7 +4513,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4514,7 +4528,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4530,14 +4544,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", "parameters": [ { "name": "sw-include-search-info", @@ -4565,7 +4579,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -4579,7 +4593,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4597,7 +4611,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4614,19 +4628,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", @@ -4636,7 +4650,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -4648,7 +4662,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4663,7 +4677,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4680,16 +4694,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", @@ -4720,16 +4734,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", @@ -4747,18 +4761,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": { @@ -4770,7 +4784,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4785,7 +4799,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4804,14 +4818,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": { @@ -4835,7 +4849,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -4849,7 +4863,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4867,7 +4881,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -4884,14 +4898,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", @@ -4920,7 +4934,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": { @@ -4939,7 +4953,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] @@ -4953,16 +4967,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" } } } @@ -4983,7 +4997,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4998,11 +5012,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", @@ -5021,14 +5035,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": { @@ -5040,7 +5054,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5055,7 +5069,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5071,14 +5085,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", "parameters": [ { "name": "sw-include-search-info", @@ -5106,7 +5120,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -5120,7 +5134,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5138,7 +5152,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5155,19 +5169,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", @@ -5177,7 +5191,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -5189,7 +5203,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5204,7 +5218,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5221,16 +5235,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", @@ -5261,16 +5275,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", @@ -5288,18 +5302,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": { @@ -5311,7 +5325,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5326,7 +5340,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -5345,14 +5359,555 @@ } } }, - "/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": { + "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 Option Value" + ], + "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 Swag Customized Products Template Option Value resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "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" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "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" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-option-value": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "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": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "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/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "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": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "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" + }, + "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" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option Value resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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": { @@ -5374,6 +5929,277 @@ } } }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value-price": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Swag Customized Products Template Option Value Price resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option-value-price?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Create a new Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-option-value-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Search for the Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", @@ -5425,51 +6251,93 @@ } } }, - "/_action/user/logout": { - "post": { + "/swag-customized-products-template-option-value-price/{id}": { + "get": { "tags": [ - "Authorization & Authentication" + "Swag Customized Products Template Option Value Price" + ], + "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": "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." + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." + "404": { + "$ref": "#/components/responses/404" }, - "403": { - "description": "The authenticated source does not have a user ID associated." + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/app-system/shop/verify": { - "get": { + }, + "delete": { "tags": [ - "App System", - "Public" + "Swag Customized Products Template Option Value Price" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "Delete a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { - "name": "runId", - "in": "query", - "description": "A unique identifier used to look up the token", + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "token", + "name": "_response", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { "type": "string" } @@ -5477,10 +6345,178 @@ ], "responses": { "204": { - "description": "An empty response signalling successful verification." + "$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" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } }, "400": { - "description": "Malformed request or unsuccessful verification." + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-option-value-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "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 SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } @@ -12886,6 +13922,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "group": { @@ -13692,6 +14762,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" @@ -15848,6 +16952,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15858,9 +16965,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -15986,6 +17090,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15996,9 +17103,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -18956,6 +20060,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -19078,6 +20185,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -20478,6 +21588,37 @@ }, "type": "object" }, + "productOpenGraphImages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } + } + } + } + }, + "type": "object" + }, "orderLineItems": { "properties": { "links": { @@ -21018,6 +22159,12 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, "orderLineItems": { "type": "array", "items": { @@ -23624,6 +24771,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -24435,6 +25616,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" @@ -29177,6 +30392,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -29413,6 +30633,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -29722,6 +30948,36 @@ }, "type": "object" }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, "featureSet": { "properties": { "links": { @@ -30503,6 +31759,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -30739,6 +32000,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -30840,6 +32107,10 @@ "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, @@ -31974,6 +33245,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -32239,6 +33514,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -34767,7 +36046,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -34877,7 +36161,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -38218,6 +39507,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -39586,6 +40937,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -40423,6 +41836,298 @@ }, "type": "object" }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -49349,6 +51054,111 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -49567,271 +51377,40 @@ ], "additionalProperties": false }, - "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" - ] - }, - "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" - ] - } - ] - }, - "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" + } } } } }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } - } - }, "Criteria": { "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)", @@ -50538,6 +52117,156 @@ "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", @@ -50582,97 +52311,87 @@ } } }, - "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" - } - } - } - } - }, - "ConsentState": { + "Price": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], + "description": "Price object", "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { + "currencyId": { "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" + "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" + "gross": { + "description": "", + "type": "number" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "net": { + "description": "", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "linked": { + "description": "", + "type": "boolean" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "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" + ] }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" + "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" + ] } }, "responses": { @@ -51471,6 +53190,14 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index ded1fb2..435861a 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,6 +1,7 @@ { "paths": [ - "/_action/user/logout", + "/aggregate/sales-channel-tracking-customer", + "/aggregate/sales-channel-tracking-order", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -11,7 +12,12 @@ "/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", + "/sales-channel-tracking-customer", + "/sales-channel-tracking-customer/{id}", + "/sales-channel-tracking-order", + "/sales-channel-tracking-order/{id}", + "/search/sales-channel-tracking-customer", + "/search/sales-channel-tracking-order", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -318,6 +324,10 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", From e70891d92c87c7043ba544dbe4a78c10bc37a232 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Apr 2026 16:49:03 +0200 Subject: [PATCH 09/12] [create-pull-request] automated change (#468) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 7641 ++++++++++++------- SwagDigitalSalesRooms-adminapi.summary.json | 16 +- 2 files changed, 4692 insertions(+), 2965 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index d7100d9..277d16b 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -4884,293 +4884,216 @@ } } }, - "/_action/user/logout": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Logout the current user", - "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", - "operationId": "userLogout", - "responses": { - "204": { - "description": "Tokens have been revoked successfully." - }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." - }, - "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - }, - "/app-system/shop/verify": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "App System", - "Public" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { - "name": "runId", + "name": "limit", "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "token", + "name": "page", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "The page to be returned", "schema": { - "type": "string" + "type": "integer" } - } - ], - "responses": { - "204": { - "description": "An empty response signalling successful verification." }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], "responses": { "200": { - "description": "", + "description": "List of Sales Channel Tracking Customer resources.", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-tracking-customer?limit=25" + }, + "last": { + "example": "/sales-channel-tracking-customer?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-tracking-customer?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-tracking-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/start": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "The sw-context-token from the attendee", - "content": { + }, "application/json": { "schema": { "type": "object", "properties": { - "attendee-sw-context-token": { - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { + }, "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", + "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "productIds" - ], - "properties": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { - "201": { - "description": "Created a new instant listing", + "200": { + "description": "Detail of SalesChannelTrackingCustomer", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } - }, - "example": { - "index": 1 } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/sales-channel-tracking-customer": { + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", + "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], @@ -5179,104 +5102,76 @@ "content": { "application/json": { "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], - "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Updated the instant listing", + "description": "List of SalesChannelTrackingCustomer", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" + "total": { + "type": "integer" }, - "pickedProductIds": { + "data": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which are picked for the instant listing" - }, - "title": { - "type": "string", - "description": "The title of the instant listing" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", + "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -5286,413 +5181,545 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingCustomer", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { + }, + "delete": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", + "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } }, - "delete": { + "patch": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", + "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } ], + "requestBody": { + "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingCustomer", "content": { - "application/json": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + ] } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { + "/aggregate/sales-channel-tracking-customer": { + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Get cart statistics", - "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", - "operationId": "getCartStatistics", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the cart line items", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "The sort of the cart line items", - "schema": { - "type": "string" + "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingCustomer", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, { "name": "limit", "in": "query", - "description": "The limit of the products which should be returned", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "integer", - "default": 10 + "type": "integer" } }, { "name": "page", "in": "query", - "description": "The page of the products which should be returned", + "description": "The page to be returned", "schema": { - "type": "integer", - "default": 1 + "type": "integer" } }, { - "name": "term", + "name": "query", "in": "query", - "description": "The search term for the products", + "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } - }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the last seen products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } } ], "responses": { "200": { - "description": "", + "description": "List of Sales Channel Tracking Order resources.", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-tracking-order?limit=25" + }, + "last": { + "example": "/sales-channel-tracking-order?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-tracking-order?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-tracking-order?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { - "get": { + }, + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "term", - "in": "query", - "description": "The search term for the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "The sort of the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "attendeeId", + "name": "_response", "in": "query", - "description": "The attendee id for which the wishlist products should be returned", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingOrder", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingOrder", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { - "message": { - "type": "string" + "total": { + "type": "integer" }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } } - }, - "example": { - "message": "Attendee removed successfully", - "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get ids of last seen products", - "description": "Get all product ids of that attendee has seen", - "operationId": "getLastSeenProductIds", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -5702,53 +5729,61 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingOrder", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "collection": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { "type": "object", "properties": { - "lastSeen": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { + }, + "delete": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -5756,85 +5791,208 @@ } }, { - "name": "sw-context-token", - "in": "header", - "description": "Contains sw-context-token value", + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { - "post": { + }, + "patch": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Add discount to the temp cart", - "description": "Add discount to the temp cart", - "operationId": "addTempDiscount", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Sales Channel Tracking Order resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelTrackingOrder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } + } + } + }, + "/aggregate/sales-channel-tracking-order": { + "post": { + "tags": [ + "Sales Channel Tracking Order", + "Experimental" ], + "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingOrder", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { "post": { "tags": [ "Appointment" ], - "summary": "Remove all discount from the temp cart", - "description": "Remove all discount from the temp cart", - "operationId": "removeTempDiscount", + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", "parameters": [ { - "name": "attendeeId", + "name": "appointmentId", "in": "path", - "description": "Attendee id", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5848,7 +6006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/JoinAppointmentResponse" } } } @@ -5856,14 +6014,68 @@ } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { + "/_action/dsr/appointment/{appointmentId}/start": { "post": { "tags": [ "Appointment" ], - "summary": "Apply the discount from the temp cart to the attendee cart", - "description": "Apply the discount from the temp cart to the attendee cart", - "operationId": "applyTempDiscount", + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/end": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", "parameters": [ { "name": "attendeeId", @@ -5878,11 +6090,19 @@ ], "responses": { "200": { - "description": "", + "description": "The sw-context-token from the attendee", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "attendee-sw-context-token": { + "type": "string" + } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" + } } } } @@ -5890,19 +6110,19 @@ } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { + "/_action/dsr/appointment/{appointmentId}/instant-listing": { "post": { "tags": [ "Appointment" ], - "summary": "Add discount to the attendee cart", - "description": "Add discount to the attendee cart", - "operationId": "addCartDiscount", + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", "parameters": [ { - "name": "attendeeId", + "name": "appointmentId", "in": "path", - "description": "Attendee id", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5915,18 +6135,164 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddCartDiscountRequestBody" + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Created a new instant listing", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" + } + }, + "example": { + "index": 1 + } + } + } + } + } + } + }, + "patch": { + "tags": [ + "Appointment" + ], + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "properties": { + "addProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "removeProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be removed to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "", + "description": "Updated the instant listing", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" + }, + "pickedProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which are picked for the instant listing" + }, + "title": { + "type": "string", + "description": "The title of the instant listing" + } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" + } } } } @@ -5934,29 +6300,53 @@ } } }, - "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { - "post": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "get": { "tags": [ "Appointment" ], - "summary": "Load line item ids of a shopping lists from the appointment", - "description": "Load line item ids of a shopping lists from the appointment", - "operationId": "setSharingShoppingList", + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", "parameters": [ { "name": "appointmentId", "in": "path", - "description": "The appointment id you are joining", + "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidePresentationStateResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", + "parameters": [ { - "name": "shoppingListId", + "name": "appointmentId", "in": "path", - "description": "The shopping list id you want to load", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5970,418 +6360,1064 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "example": { - "data": { - "01938f89c632709ba4d65eb53604bf5b": { - "quantity": "1" - }, - "01938f89c8647036a617b7d88e1e24f5": { - "quantity": "1" - }, - "01938f8a23d47305b1e289163cea5074": { - "quantity": "1" - } - } - } - } - } + "$ref": "#/components/schemas/VideoChatCreateStruct" } } } } - }, - "security": [ + } + }, + "delete": { + "tags": [ + "Appointment" + ], + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", + "parameters": [ { - "ApiKey": [] + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" - }, - { - "$ref": "#/components/schemas/pagination" + "responses": { + "200": { + "description": "", + "content": { + "application/json": [] + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + } } - ] - }, - "data": { - "$ref": "#/components/schemas/data" - }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + } } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { + "tags": [ + "Appointment" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + "summary": "Get cart insights", + "description": "Get cart insights for the given appointment", + "operationId": "getCartInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCartInsightsResponse" + } + } + } } - }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "name": "order", + "in": "query", + "description": "The order of the cart line items", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the cart line items", + "schema": { + "type": "string" + } } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "attributes": { - "$ref": "#/components/schemas/attributes" + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } }, - "relationships": { - "$ref": "#/components/schemas/relationships" + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } }, - "links": { - "$ref": "#/components/schemas/links" + { + "name": "term", + "in": "query", + "description": "The search term for the products", + "schema": { + "type": "string" + } }, - "meta": { - "$ref": "#/components/schemas/meta" + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the last seen products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" } - }, - { - "$ref": "#/components/schemas/link" } - ] - }, - "related": { - "$ref": "#/components/schemas/link" + } } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", + "parameters": [ { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 } - } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ + }, { - "required": [ - "data" - ] + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } }, { - "required": [ - "meta" - ] + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } }, { - "required": [ - "links" - ] + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } }, { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" + "name": "sort", + "in": "query", + "description": "The sort of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the wishlist products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" + } }, - { - "$ref": "#/components/schemas/relationshipToMany" + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } - ] + } } } } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "get": { + "tags": [ + "Appointment" ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." - }, + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", + "parameters": [ { - "$ref": "#/components/schemas/linkage" + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "collection": { + "type": "object", + "properties": { + "lastSeen": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] + } + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Load a temporary cart for the attendee", + "description": "Load a temporary cart for the attendee", + "operationId": "loadTempCart", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "meta": { - "$ref": "#/components/schemas/meta" + { + "name": "sw-context-token", + "in": "header", + "description": "Contains sw-context-token value", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddTempDiscountRequestBody" + } + } } }, - "type": "object", - "additionalProperties": false - }, - "pagination": { + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Apply the discount from the temp cart to the attendee cart", + "description": "Apply the discount from the temp cart to the attendee cart", + "operationId": "applyTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCartDiscountRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Load line item ids of a shopping lists from the appointment", + "description": "Load line item ids of a shopping lists from the appointment", + "operationId": "setSharingShoppingList", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "The appointment id you are joining", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "shoppingListId", + "in": "path", + "description": "The shopping list id you want to load", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "example": { + "data": { + "01938f89c632709ba4d65eb53604bf5b": { + "quantity": "1" + }, + "01938f89c8647036a617b7d88e1e24f5": { + "quantity": "1" + }, + "01938f8a23d47305b1e289163cea5074": { + "quantity": "1" + } + } + } + } + } + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" + ], "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" + "meta": { + "$ref": "#/components/schemas/meta" }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" + "data": { + "$ref": "#/components/schemas/data" }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } }, - "type": "object" + "type": "object", + "additionalProperties": false }, - "jsonapi": { - "description": "An object describing the server's implementation", + "failure": { + "required": [ + "errors" + ], "properties": { - "version": { - "type": "string" - }, "meta": { "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true } }, "type": "object", "additionalProperties": false }, - "error": { + "info": { + "required": [ + "meta" + ], "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." + "meta": { + "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" + } + }, + "type": "object" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/components/schemas/resource" }, - "code": { - "type": "string", - "description": "An application-specific error code, expressed as a string value." + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" }, - "title": { - "type": "string", - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + "id": { + "type": "string" }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." + "relationships": { + "$ref": "#/components/schemas/relationships" }, - "source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." - }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." - } - } + "links": { + "$ref": "#/components/schemas/links" }, "meta": { "$ref": "#/components/schemas/meta" } }, + "type": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "#/components/schemas/link" + } + ] + }, + "related": { + "$ref": "#/components/schemas/link" + } + }, "type": "object", - "additionalProperties": false + "additionalProperties": true }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "$ref": "#/components/schemas/resource" + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { + "type": "object", "required": [ - "id", - "name" + "href" ], "properties": { - "id": { + "href": { + "description": "A string containing the link's URL.", "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" - }, - "description": { - "description": "A short description of the ACL role.", - "type": "string" + "format": "uri-reference" }, - "privileges": { - "type": "array", - "items": { - "type": "string" + "meta": { + "$ref": "#/components/schemas/meta" + } + } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] + }, + { + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" + }, + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] + } + } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, + { + "$ref": "#/components/schemas/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" + }, + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" + }, + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" + }, + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" + } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "error": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for this particular occurrence of the problem." + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "status": { + "type": "string", + "description": "The HTTP status code applicable to this problem, expressed as a string value." + }, + "code": { + "type": "string", + "description": "An application-specific error code, expressed as a string value." + }, + "title": { + "type": "string", + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." + }, + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" } }, "deletedAt": { @@ -13540,6 +14576,35 @@ }, "extensions": { "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, "attendee": { "properties": { "links": { @@ -14382,6 +15447,35 @@ }, "extensions": { "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, "attendee": { "properties": { "links": { @@ -16572,6 +17666,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16582,9 +17679,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -16710,6 +17804,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16720,9 +17817,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -21925,6 +23019,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -22047,6 +23144,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -23416,6 +24516,37 @@ }, "type": "object" }, + "productOpenGraphImages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } + } + } + } + }, + "type": "object" + }, "orderLineItems": { "properties": { "links": { @@ -23925,6 +25056,12 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, "orderLineItems": { "type": "array", "items": { @@ -26531,6 +27668,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -27342,6 +28513,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" @@ -32084,6 +33289,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -32320,6 +33530,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -32662,6 +33878,36 @@ }, "type": "object" }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, "featureSet": { "properties": { "links": { @@ -33446,6 +34692,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -33682,6 +34933,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -33816,6 +35073,10 @@ "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, @@ -34950,6 +36211,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -35215,6 +36480,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -37818,7 +39087,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -37928,7 +39202,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -41135,6 +42414,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -42503,6 +43844,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -43412,6 +44815,298 @@ }, "type": "object" }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -50374,6 +52069,111 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -50592,271 +52392,40 @@ ], "additionalProperties": false }, - "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" - ] - }, - "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" - ] - } - ] - }, - "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" + } } } } }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } - } - }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -51563,6 +53132,156 @@ "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", @@ -51607,291 +53326,87 @@ } } }, - "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" - } - } - } - } - }, - "ConsentState": { + "Price": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], + "description": "Price object", "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": { + "currencyId": { "type": "string", - "description": "The resolved identifier of the consent" + "pattern": "^[0-9a-f]{32}$" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "gross": { + "description": "", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "net": { + "description": "", + "type": "number" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "linked": { + "description": "", + "type": "boolean" }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" - } - } - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { + "listPrice": { + "description": "", "type": "object", "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { + "currencyId": { "type": "string", - "format": "date-time" - } - } - }, - "identifier": { - "type": "string" - }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } - } - }, - "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" + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" - }, - "JWTMercureSubscriberToken": { - "oneOf": [ - { - "type": "string" + "gross": { + "description": "", + "type": "number" }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to publish updates" - }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" + "net": { + "description": "", + "type": "number" }, - { - "type": "null" + "linked": { + "description": "", + "type": "boolean" } - ], - "description": "The mercure hub url to connect for subscribing and updating" + }, + "required": [ + "gross", + "net", + "linked" + ] }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to subscribe for updates" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" - }, - "newContextToken": { - "type": "string", - "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" - }, - "salesChannelName": { - "type": "string", - "description": "The name of the current sales channel" - }, - "appointmentName": { - "type": "string", - "description": "The name of the appointment" - }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" - }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" - }, - "attendeeName": { - "oneOf": [ - { - "type": "string" + "gross": { + "description": "", + "type": "number" }, - { - "type": "null" - } - ], - "description": "The name of the attendee" - }, - "videoUserId": { - "oneOf": [ - { - "type": "string" + "net": { + "description": "", + "type": "number" }, - { - "type": "null" - } - ], - "description": "The video user id that attendee could use" - }, - "b2bFeatures": { - "type": "object", - "description": "The b2b features that available for the appointment", - "properties": { - "quoteManagement": { - "type": "boolean", - "description": "To know if the quote management is enabled for current customer" + "linked": { + "description": "", + "type": "boolean" } - } + }, + "required": [ + "gross", + "net", + "linked" + ] } }, - "example": { - "mercureSubscriberTopics": [ - "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" - ], - "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", - "JWTMercureSubscriberToken": "jwt token for subscribing to updates", - "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", - "JWTMercurePublisherToken": "jwt token for publishing updates", - "attendeeName": "attendee name", - "videoUserId": null, - "b2bFeatures": { - "feature1": false, - "feature2": true - }, - "id": "2d2c358f1ca04098aacf12873c2eed82", - "newContextToken": "new context token to call the other routes", - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", - "salesChannelName": "Storefront", - "appointmentName": "Test Appointment", - "presentationGuideMode": "guided", - "isPreview": false, - "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" - } + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] }, "CartPriceQuantity": { "type": "object", @@ -51946,117 +53461,345 @@ "apiAlias" ] }, - "AbstractDynamicPageOpenedPayload": { + "CartDeliveryPosition": { "type": "object", - "required": [ - "type" - ], + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "opened": { - "type": "boolean", - "default": true + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } } }, - "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": { + "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": [] } }, - "CartPriceReference": { + "LineItem": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "referenceUnit": { - "type": "number" + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "unitName": { + "dataContextHash": { "type": "string" }, - "price": { - "type": "number" + "dataTimestamp": { + "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "listPrice": { - "oneOf": [ + "description": { + "type": "string" + }, + "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 + } + } } ] }, - "regulationPrice": { + "extensions": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } + } + } + }, + "price": { "type": "object", "properties": { - "price": { - "type": "number" - }, "apiAlias": { "type": "string", "enum": [ - "cart_regulation_price" + "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" + } + } + } } }, - "nullable": true + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] }, - "hasRange": { + "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" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "stackable": { + "type": "boolean" + }, + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" + "id", + "type" ] }, + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" + } + } + }, "CartDelivery": { "type": "object", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", @@ -52159,578 +53902,223 @@ } } }, - "BasePresentationSlideData": { + "GuidePresentationStateResponse": { + "type": "object", "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "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": [] } } }, - "PresentationSlideData": { + "GetCartInsightsResponse": { "type": "object", + "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" - } - } + "productCount": { + "type": "number", + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "product": { - "$ref": "#/components/schemas/Product" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" }, - "category": { - "$ref": "#/components/schemas/Category" + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" }, - "configurator": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" + "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": { - "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" + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 }, - "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": [ { - "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" + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 } ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" - }, - "category": { - "versionId": null, - "translated": { - "breadcrumb": [] - }, - "createdAt": null, - "updatedAt": null, - "afterCategoryId": null, - "parentId": null, - "mediaId": null, - "name": null, - "breadcrumb": [], - "path": null, - "level": null, - "active": null, - "childCount": null, - "visibleChildCount": 0, - "displayNestedProducts": null, - "parent": null, - "children": null, - "translations": null, - "media": null, - "cmsPageId": null, - "cmsPageIdSwitched": false, - "cmsPage": null, - "linkType": null, - "linkNewTab": null, - "internalLink": null, - "externalLink": null, - "visible": null, - "type": null, - "productAssignmentType": null, - "description": null, - "metaTitle": null, - "metaDescription": null, - "keywords": null, - "seoUrls": null, - "customEntityTypeId": null, - "id": "34f21c5eb6d54a939f10973204aa5f08", - "customFields": null, - "apiAlias": "category" - }, - "apiAlias": "pwa_page_result" + "byRevenue": [ + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 + }, + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 + } + ] + } } }, - "StateForGuides": { + "WidgetProductListing": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "inactiveClients": { + "extensions": { "type": "array", - "items": { - "type": "string" - }, + "description": "List of extensions", "default": [] }, - "guides": { + "products": { "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "videoGuideToken": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "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" - } - } - }, - "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", + "description": "List of last seen products", "items": { "allOf": [ { @@ -52769,553 +54157,563 @@ } } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" - ] - }, - "DiscountLineItemPayload": { + "GetAttendeeInsightsResponse": { "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" + } }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 + "currencySymbol": { + "type": "string" } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" } }, - "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" + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" + "roomName": { + "type": "string", + "description": "Name of the video room in daily" }, - "description": { - "type": "string" + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" }, - "good": { - "type": "boolean" + "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": [] + } + }, + "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" + } + } + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" }, - "id": { - "type": "string" + "referenceUnit": { + "type": "number" }, - "label": { + "unitName": { "type": "string" }, - "modified": { - "type": "boolean" + "price": { + "type": "number" }, - "modifiedByApp": { - "type": "boolean" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] }, - "payload": { - "allOf": [ + "listPrice": { + "oneOf": [ { - "$ref": "#/components/schemas/ProductJsonApi" + "$ref": "#/components/schemas/CartListPrice" }, { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } + "type": "null" } ] }, - "extensions": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } - } - } - }, - "price": { + "regulationPrice": { "type": "object", "properties": { + "price": { + "type": "number" + }, "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" - } + "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" + ] + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + { + "type": "null" + } + ] + }, + "lastActiveGuideSection": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + { + "type": "null" + } + ] + }, + "currentPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "type": "number" + { + "type": "null" + } + ] + }, + "currentSectionId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unitPrice": { - "type": "number" + { + "type": "null" + } + ] + }, + "currentSlideAlias": { + "type": "integer", + "default": 0 + }, + "currentSlideData": { + "anyOf": [ + { + "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + { + "type": "null" } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" ] }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "currentDynamicPage": { + "$ref": "#/components/schemas/DynamicPageOpenedPayload" }, - "quantity": { - "type": "number" + "started": { + "type": "boolean", + "default": false }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" + "running": { + "type": "boolean", + "default": false + }, + "ended": { + "type": "boolean", + "default": false + }, + "startedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" }, - "minPurchase": { - "type": "number" + { + "type": "null" + } + ] + }, + "endedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" }, - "purchaseSteps": { - "type": "number" + { + "type": "null" } - } + ] }, - "referencedId": { - "type": "string" + "accessibleFrom": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] }, - "removable": { - "type": "boolean" + "accessibleTo": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] }, - "stackable": { - "type": "boolean" + "appointmentMode": { + "type": "string", + "enum": [ + "guided", + "self" + ] }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" }, - "type": { - "$ref": "#/components/schemas/LineItemType" + "videoRoomUrl": { + "type": "string", + "default": "" }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "attendeeRestrictionType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] + }, + { + "type": "null" + } + ] }, - { - "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" + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" } - } + ] + }, + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "productListingDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "broadcastMode": { + "type": "boolean", + "default": false + }, + "viewMode": { + "type": "string", + "enum": [ + "onlyYou", + "presentation", + "videoGrid" + ], + "default": "presentation" + }, + "allowScreenSharing": { + "type": "boolean", + "default": false + }, + "extensions": { + "type": "array", + "default": [] } - ] + } }, - "AttendeeInsights": { + "StateForGuides": { "type": "object", - "description": "Attendee Insights", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "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 + "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": { + "CalculatedPrice": { "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" + "unitPrice": { + "type": "number" }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" + "quantity": { + "type": "number" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" + "rawTotal": { + "type": "number" }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" + "totalPrice": { + "type": "number" }, - "topProducts": { - "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], - "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } - }, - "required": [ - "productId", - "value" + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" } }, - "byRevenue": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The net revenue in the shown currency in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } - } + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, + }, + "referencePrice": { + "oneOf": [ { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 + "$ref": "#/components/schemas/CartPriceReference" }, { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 + "type": "null" } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 - }, + ] + }, + "listPrice": { + "oneOf": [ { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 + "$ref": "#/components/schemas/CartListPrice" }, { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + "type": "null" } ] - } - } - }, - "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": [] + "positionPrice": { + "type": "number" }, - "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 + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true + "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" + } } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] + } + } + }, + "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" } } }, @@ -53377,520 +54775,831 @@ "apiAlias" ] }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], + "CartListPrice": { + "type": "object", + "description": "", "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] } - } + }, + "required": [ + "apiAlias" + ] }, - "StateForAll": { + "Cart": { "type": "object", "properties": { - "currentGuideProductId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "lastActiveGuideSection": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "currentSlideAlias": { - "type": "integer", - "default": 0 + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" + } }, - "currentSlideData": { - "anyOf": [ - { - "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" - }, - { - "type": "null" + "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" + } } - ] + } }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" + "modified": { + "type": "boolean" }, - "started": { - "type": "boolean", - "default": false + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "running": { - "type": "boolean", - "default": false + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true }, - "ended": { + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { "type": "boolean", - "default": false + "default": true + } + } + }, + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "startedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + "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": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" } - ] + } + } + } + }, + "PresentationSlideData": { + "type": "object", + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "accessibleFrom": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" } - ] + } }, - "accessibleTo": { - "anyOf": [ - { - "type": "string", - "format": "date-time" + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "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" + } + }, + "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" } - ] + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, - "appointmentMode": { - "type": "string", - "enum": [ - "guided", - "self" - ] + "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" }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" + "apiAlias": "pwa_page_result" + } + }, + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" }, - "videoRoomUrl": { - "type": "string", - "default": "" + { + "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" + } + } + } + ] + }, + "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" }, - "attendeeRestrictionType": { - "anyOf": [ + "mercurePublisherTopic": { + "oneOf": [ { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] + "type": "string" }, { "type": "null" } - ] + ], + "description": "The topic to which the attendee/guide can send updates" }, - "productDetailDefaultPageId": { - "anyOf": [ + "JWTMercureSubscriberToken": { + "oneOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" }, { "type": "null" } - ] + ], + "description": "The JWT mercure token to publish updates" }, - "quickviewPageId": { - "anyOf": [ + "mercureHubPublicUrl": { + "oneOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" }, { "type": "null" } - ] + ], + "description": "The mercure hub url to connect for subscribing and updating" }, - "productListingDefaultPageId": { - "anyOf": [ + "JWTMercurePublisherToken": { + "oneOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" }, { "type": "null" } - ] - }, - "broadcastMode": { - "type": "boolean", - "default": false - }, - "viewMode": { - "type": "string", - "enum": [ - "onlyYou", - "presentation", - "videoGrid" ], - "default": "presentation" - }, - "allowScreenSharing": { - "type": "boolean", - "default": false - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" + "description": "The JWT mercure token to subscribe for updates" }, - "apiAlias": { + "id": { "type": "string", - "enum": [ - "cart_list_price" - ] - } - }, - "required": [ - "apiAlias" - ] - }, - "GetAttendeeInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", - "properties": { - "attendees": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" }, - "currencyId": { + "newContextToken": { "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": "$" - } - }, - "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" - } - } - } - } - }, - "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" + "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, - "customerComment": { + "attendeeId": { "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" }, - "affiliateCode": { + "salesChannelId": { "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" }, - "campaignCode": { + "salesChannelName": { "type": "string", - "description": "A campaign tracking code", - "nullable": true - } - } - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" + "description": "The name of the current sales channel" }, - "rawTotal": { - "type": "number" + "appointmentName": { + "type": "string", + "description": "The name of the appointment" }, - "totalPrice": { - "type": "number" + "presentationGuideMode": { + "type": "string", + "enum": [ + "self", + "guided" + ], + "description": "The type of the appointment" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } + "isPreview": { + "type": "boolean", + "description": "To see if it's a preview appointment" }, - "referencePrice": { + "attendeeName": { "oneOf": [ { - "$ref": "#/components/schemas/CartPriceReference" + "type": "string" }, { "type": "null" } - ] + ], + "description": "The name of the attendee" }, - "listPrice": { + "videoUserId": { "oneOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "type": "string" }, { "type": "null" } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" + ], + "description": "The video user id that attendee could use" }, - "regulationPrice": { + "b2bFeatures": { "type": "object", + "description": "The b2b features that available for the appointment", "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" } } } }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" + "example": { + "mercureSubscriberTopics": [ + "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" + ], + "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", + "JWTMercureSubscriberToken": "jwt token for subscribing to updates", + "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", + "JWTMercurePublisherToken": "jwt token for publishing updates", + "attendeeName": "attendee name", + "videoUserId": null, + "b2bFeatures": { + "feature1": false, + "feature2": true + }, + "id": "2d2c358f1ca04098aacf12873c2eed82", + "newContextToken": "new context token to call the other routes", + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", + "salesChannelName": "Storefront", + "appointmentName": "Test Appointment", + "presentationGuideMode": "guided", + "isPreview": false, + "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } ] } }, @@ -54726,6 +56435,14 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index c068d50..6faf772 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,7 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/user/logout", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -30,7 +29,8 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/app-system/shop/verify", + "/aggregate/sales-channel-tracking-customer", + "/aggregate/sales-channel-tracking-order", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -49,6 +49,10 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", + "/sales-channel-tracking-customer", + "/sales-channel-tracking-customer/{id}", + "/sales-channel-tracking-order", + "/sales-channel-tracking-order/{id}", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request", @@ -57,7 +61,9 @@ "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", - "/search/dsr-presentation-cms-page" + "/search/dsr-presentation-cms-page", + "/search/sales-channel-tracking-customer", + "/search/sales-channel-tracking-order" ], "schemas": [ "AbstractDynamicPageOpenedPayload", @@ -380,6 +386,10 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", From a2e4c76e8d2c57240ab0147654ee407e98e050ad 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:30:52 +0200 Subject: [PATCH 10/12] [create-pull-request] automated change (#475) Co-authored-by: shopwareBot --- adminapi.json | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/adminapi.json b/adminapi.json index 8596036..59d8ae1 100644 --- a/adminapi.json +++ b/adminapi.json @@ -103975,12 +103975,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", @@ -104200,6 +104194,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", @@ -105317,12 +105318,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", @@ -105564,6 +105559,13 @@ "deprecated": true, "description": "Internal field." }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", From f498ee350e83f026f91540e92ee742d107c7ce74 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 13:52:25 +0200 Subject: [PATCH 11/12] [create-pull-request] automated change (#482) Co-authored-by: shopwareBot --- adminapi.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/adminapi.json b/adminapi.json index 59d8ae1..3b6cf90 100644 --- a/adminapi.json +++ b/adminapi.json @@ -115893,6 +115893,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", @@ -116101,6 +116106,11 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", From 1b96840ba6648dd4b435aefb68d86320ec2f09bc Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Mon, 27 Apr 2026 10:42:39 +0000 Subject: [PATCH 12/12] [create-pull-request] automated change --- SwagCustomizedProducts-adminapi.json | 2110 +++++------------- SwagCustomizedProducts-adminapi.summary.json | 8 - 2 files changed, 525 insertions(+), 1593 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 6287809..5fed4e7 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -15,15 +15,14 @@ } ], "paths": { - "/sales-channel-tracking-customer": { + "/swag-customized-products-template": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "List with basic information of Swag Customized Products Template resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateList", "parameters": [ { "name": "limit", @@ -52,7 +51,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Swag Customized Products Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -71,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] @@ -85,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/swag-customized-products-template?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/swag-customized-products-template?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/swag-customized-products-template?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/swag-customized-products-template?limit=25&page=2" } } } @@ -115,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -130,12 +129,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "Create a new Swag Customized Products Template resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplate", "parameters": [ { "name": "_response", @@ -154,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -173,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -188,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -204,15 +202,14 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/swag-customized-products-template": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "Search for the Swag Customized Products Template resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplate", "parameters": [ { "name": "sw-include-search-info", @@ -240,7 +237,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -254,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -272,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -289,20 +286,19 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/swag-customized-products-template/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "Detailed information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -312,7 +308,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -324,7 +320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -339,7 +335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -356,17 +352,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "summary": "Delete a Swag Customized Products Template resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -397,17 +392,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "Partially update information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -425,18 +419,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Swag Customized Products Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -448,7 +442,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -463,7 +457,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -482,15 +476,14 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/swag-customized-products-template": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingCustomer", + "summary": "Aggregate for the Swag Customized Products Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { @@ -514,7 +507,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -528,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -546,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -563,15 +556,14 @@ } } }, - "/sales-channel-tracking-order": { + "/swag-customized-products-template-configuration": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "summary": "List with basic information of Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfigurationList", "parameters": [ { "name": "limit", @@ -600,7 +592,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Swag Customized Products Template Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -619,7 +611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] @@ -633,16 +625,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/swag-customized-products-template-configuration?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/swag-customized-products-template-configuration?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/swag-customized-products-template-configuration?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/swag-customized-products-template-configuration?limit=25&page=2" } } } @@ -663,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -678,12 +670,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Create a new Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "_response", @@ -702,14 +693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -721,7 +712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -736,7 +727,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -752,15 +743,14 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/swag-customized-products-template-configuration": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Search for the Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "sw-include-search-info", @@ -788,7 +778,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -802,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -820,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -837,20 +827,19 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/swag-customized-products-template-configuration/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -860,7 +849,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -872,7 +861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -887,7 +876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -904,17 +893,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "summary": "Delete a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -945,17 +933,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -973,18 +960,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -996,7 +983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1011,7 +998,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1030,15 +1017,14 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/swag-customized-products-template-configuration": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingOrder", + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { @@ -1062,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -1076,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1094,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1111,14 +1097,14 @@ } } }, - "/swag-customized-products-template": { + "/swag-customized-products-template-configuration-share": { "get": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "List with basic information of Swag Customized Products Template resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", "parameters": [ { "name": "limit", @@ -1147,7 +1133,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template resources.", + "description": "List of Swag Customized Products Template Configuration Share resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1166,7 +1152,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] @@ -1180,16 +1166,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template?limit=25" + "example": "/swag-customized-products-template-configuration-share?limit=25" }, "last": { - "example": "/swag-customized-products-template?limit=25&page=11" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template?limit=25&page=4" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" } } } @@ -1210,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1225,11 +1211,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Create a new Swag Customized Products Template resources.", + "summary": "Create a new Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplate", + "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "_response", @@ -1248,14 +1234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1267,7 +1253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1282,7 +1268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1298,14 +1284,14 @@ } } }, - "/search/swag-customized-products-template": { + "/search/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Search for the Swag Customized Products Template resources.", + "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", + "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "sw-include-search-info", @@ -1333,7 +1319,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1347,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1365,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1382,19 +1368,19 @@ } } }, - "/swag-customized-products-template/{id}": { + "/swag-customized-products-template-configuration-share/{id}": { "get": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Detailed information about a Swag Customized Products Template resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplate", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1404,7 +1390,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1416,7 +1402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1431,7 +1417,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1448,16 +1434,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Delete a Swag Customized Products Template resource.", + "summary": "Delete a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", + "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1488,16 +1474,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Partially update information about a Swag Customized Products Template resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", + "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1515,18 +1501,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1538,7 +1524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1553,7 +1539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1572,14 +1558,14 @@ } } }, - "/aggregate/swag-customized-products-template": { + "/aggregate/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Aggregate for the Swag Customized Products Template resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplate", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { @@ -1603,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1617,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1635,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1652,14 +1638,14 @@ } } }, - "/swag-customized-products-template-configuration": { + "/swag-customized-products-template-exclusion": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", + "operationId": "getSwagCustomizedProductsTemplateExclusionList", "parameters": [ { "name": "limit", @@ -1688,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration resources.", + "description": "List of Swag Customized Products Template Exclusion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1707,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] @@ -1721,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration?limit=25" + "example": "/swag-customized-products-template-exclusion?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion?limit=25&page=2" } } } @@ -1751,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1766,11 +1752,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", + "summary": "Create a new Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", + "operationId": "createSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "_response", @@ -1789,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1808,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1823,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1839,14 +1825,14 @@ } } }, - "/search/swag-customized-products-template-configuration": { + "/search/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", + "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "operationId": "searchSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "sw-include-search-info", @@ -1874,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1888,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1906,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1923,19 +1909,19 @@ } } }, - "/swag-customized-products-template-configuration/{id}": { + "/swag-customized-products-template-exclusion/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", + "operationId": "getSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -1945,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1957,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1972,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1989,16 +1975,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", + "summary": "Delete a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "operationId": "deleteSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -2029,16 +2015,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "operationId": "updateSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -2056,18 +2042,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -2079,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2094,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2113,14 +2099,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration": { + "/aggregate/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { @@ -2144,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -2158,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2176,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2193,14 +2179,14 @@ } } }, - "/swag-customized-products-template-configuration-share": { + "/swag-customized-products-template-exclusion-condition": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", "parameters": [ { "name": "limit", @@ -2229,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration Share resources.", + "description": "List of Swag Customized Products Template Exclusion Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2248,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] @@ -2262,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration-share?limit=25" + "example": "/swag-customized-products-template-exclusion-condition?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" } } } @@ -2292,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2307,11 +2293,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Create a new Swag Customized Products Template Configuration Share resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "_response", @@ -2330,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2349,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2364,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2380,14 +2366,14 @@ } } }, - "/search/swag-customized-products-template-configuration-share": { + "/search/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Search for the Swag Customized Products Template Configuration Share resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "sw-include-search-info", @@ -2415,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2429,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2447,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2464,19 +2450,19 @@ } } }, - "/swag-customized-products-template-configuration-share/{id}": { + "/swag-customized-products-template-exclusion-condition/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2486,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2498,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2513,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2530,16 +2516,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Delete a Swag Customized Products Template Configuration Share resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2570,16 +2556,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2597,18 +2583,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2620,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2635,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2654,14 +2640,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration-share": { + "/aggregate/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { @@ -2685,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2699,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2717,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2734,14 +2720,14 @@ } } }, - "/swag-customized-products-template-exclusion": { + "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { "name": "limit", @@ -2770,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion resources.", + "description": "List of Swag Customized Products Template Exclusion Operator resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2789,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] @@ -2803,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion?limit=25" + "example": "/swag-customized-products-template-exclusion-operator?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" } } } @@ -2833,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2848,11 +2834,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Create a new Swag Customized Products Template Exclusion resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusion", + "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "_response", @@ -2871,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -2890,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2905,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2921,14 +2907,14 @@ } } }, - "/search/swag-customized-products-template-exclusion": { + "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Search for the Swag Customized Products Template Exclusion resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "sw-include-search-info", @@ -2956,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -2970,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2988,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3005,19 +2991,19 @@ } } }, - "/swag-customized-products-template-exclusion/{id}": { + "/swag-customized-products-template-exclusion-operator/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusion", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3027,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3039,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3054,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3071,16 +3057,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Delete a Swag Customized Products Template Exclusion resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3111,16 +3097,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3138,18 +3124,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3161,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3176,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3195,14 +3181,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion": { + "/aggregate/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { @@ -3226,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3240,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3258,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3275,14 +3261,14 @@ } } }, - "/swag-customized-products-template-exclusion-condition": { + "/swag-customized-products-template-option": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", + "summary": "List with basic information of Swag Customized Products Template Option resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "operationId": "getSwagCustomizedProductsTemplateOptionList", "parameters": [ { "name": "limit", @@ -3311,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Condition resources.", + "description": "List of Swag Customized Products Template Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3330,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] @@ -3344,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25" + "example": "/swag-customized-products-template-option?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + "example": "/swag-customized-products-template-option?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + "example": "/swag-customized-products-template-option?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + "example": "/swag-customized-products-template-option?limit=25&page=2" } } } @@ -3374,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3389,11 +3375,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", + "summary": "Create a new Swag Customized Products Template Option resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "createSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "_response", @@ -3412,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3431,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3446,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3462,14 +3448,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-condition": { + "/search/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "searchSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "sw-include-search-info", @@ -3497,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3511,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3529,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3546,19 +3532,19 @@ } } }, - "/swag-customized-products-template-exclusion-condition/{id}": { + "/swag-customized-products-template-option/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Detailed information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "getSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3568,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3580,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3595,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3612,16 +3598,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Delete a Swag Customized Products Template Option resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "deleteSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3652,16 +3638,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Partially update information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "updateSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3679,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3702,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3717,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3736,14 +3722,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-condition": { + "/aggregate/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Aggregate for the Swag Customized Products Template Option resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "aggregateSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { @@ -3767,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3781,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3799,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3816,14 +3802,14 @@ } } }, - "/swag-customized-products-template-exclusion-operator": { + "/swag-customized-products-template-option-price": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "summary": "List with basic information of Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", + "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", "parameters": [ { "name": "limit", @@ -3852,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "description": "List of Swag Customized Products Template Option Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3871,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] @@ -3885,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25" + "example": "/swag-customized-products-template-option-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + "example": "/swag-customized-products-template-option-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + "example": "/swag-customized-products-template-option-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + "example": "/swag-customized-products-template-option-price?limit=25&page=2" } } } @@ -3915,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -3930,11 +3916,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "summary": "Create a new Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "createSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "_response", @@ -3953,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -3972,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -3987,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4003,14 +3989,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-operator": { + "/search/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "sw-include-search-info", @@ -4038,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4052,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4070,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4087,19 +4073,19 @@ } } }, - "/swag-customized-products-template-exclusion-operator/{id}": { + "/swag-customized-products-template-option-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "getSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4109,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4121,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4136,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4153,16 +4139,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Delete a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4193,16 +4179,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4220,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4243,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4258,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4277,14 +4263,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-operator": { + "/aggregate/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { @@ -4308,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4322,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4340,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4357,14 +4343,14 @@ } } }, - "/swag-customized-products-template-option": { + "/swag-customized-products-template-option-value": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "List with basic information of Swag Customized Products Template Option resources.", + "summary": "List with basic information of Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionList", + "operationId": "getSwagCustomizedProductsTemplateOptionValueList", "parameters": [ { "name": "limit", @@ -4393,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option resources.", + "description": "List of Swag Customized Products Template Option Value resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4412,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } ] @@ -4426,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option?limit=25" + "example": "/swag-customized-products-template-option-value?limit=25" }, "last": { - "example": "/swag-customized-products-template-option?limit=25&page=11" + "example": "/swag-customized-products-template-option-value?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option?limit=25&page=4" + "example": "/swag-customized-products-template-option-value?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option?limit=25&page=2" + "example": "/swag-customized-products-template-option-value?limit=25&page=2" } } } @@ -4456,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4471,11 +4457,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "Create a new Swag Customized Products Template Option resources.", + "summary": "Create a new Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOption", + "operationId": "createSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "_response", @@ -4494,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -4513,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4528,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4544,1096 +4530,14 @@ } } }, - "/search/swag-customized-products-template-option": { + "/search/swag-customized-products-template-option-value": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "Search for the Swag Customized Products Template Option resources.", + "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOption", - "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 SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-option/{id}": { - "get": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Detailed information about a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Delete a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Partially update information about a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/swag-customized-products-template-option": { - "post": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Aggregate for the Swag Customized Products Template Option resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOption", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-option-price": { - "get": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "List with basic information of Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Swag Customized Products Template Option Price resources.", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-option-price?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-option-price?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-option-price?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-option-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Create a new Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template-option-price": { - "post": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Search for the Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", - "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-price/{id}": { - "get": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - }, - "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" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "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" - } - } - ], - "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Price resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/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 Option Value" - ], - "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 Swag Customized Products Template Option Value resources.", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "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" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "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" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template-option-value": { - "post": { - "tags": [ - "Swag Customized Products Template Option Value" - ], - "summary": "Search for the Swag Customized Products Template Option Value resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "operationId": "searchSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "sw-include-search-info", @@ -30430,12 +29334,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", @@ -30655,6 +29553,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", @@ -31797,12 +30702,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", @@ -32022,6 +30921,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", @@ -34272,6 +33178,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -34282,9 +33191,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -34401,6 +33307,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -34411,9 +33320,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -42320,6 +41226,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", @@ -42524,6 +41435,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", @@ -52316,39 +51232,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" } }, @@ -52359,23 +51298,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" } }, diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index 435861a..dd113c6 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,7 +1,5 @@ { "paths": [ - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -12,12 +10,6 @@ "/aggregate/swag-customized-products-template-option-price", "/aggregate/swag-customized-products-template-option-value", "/aggregate/swag-customized-products-template-option-value-price", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share",