diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index c3c26f3..74d3eee 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -210,6 +210,21 @@ "summary": "Search for the Advanced Search Action resources.", "description": "", "operationId": "searchAdvancedSearchAction", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -736,282 +751,297 @@ "summary": "Search for the Advanced Search Action Search Term resources.", "description": "", "operationId": "searchAdvancedSearchActionSearchTerm", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of AdvancedSearchActionSearchTerm", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/advanced-search-action-search-term/{id}": { - "get": { - "tags": [ - "Advanced Search Action Search Term" - ], - "summary": "Detailed information about a Advanced Search Action Search Term resource.", - "description": "", - "operationId": "getAdvancedSearchActionSearchTerm", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_action_search_term", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AdvancedSearchActionSearchTerm", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Advanced Search Action Search Term" - ], - "summary": "Delete a Advanced Search Action Search Term resource.", - "description": "", - "operationId": "deleteAdvancedSearchActionSearchTerm", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_action_search_term", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Advanced Search Action Search Term" - ], - "summary": "Partially update information about a Advanced Search Action Search Term resource.", - "description": "", - "operationId": "updateAdvancedSearchActionSearchTerm", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_action_search_term", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Advanced Search Action Search Term resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AdvancedSearchActionSearchTerm", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/advanced-search-action-search-term": { - "post": { - "tags": [ - "Advanced Search Action Search Term" ], - "summary": "Aggregate for the Advanced Search Action Search Term resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAdvancedSearchActionSearchTerm", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-action-search-term/{id}": { + "get": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Detailed information about a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "getAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Delete a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "deleteAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Partially update information about a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "updateAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Advanced Search Action Search Term resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/advanced-search-action-search-term": { + "post": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Aggregate for the Advanced Search Action Search Term resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchActionSearchTerm", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -1262,6 +1292,21 @@ "summary": "Search for the Advanced Search Boosting resources.", "description": "", "operationId": "searchAdvancedSearchBoosting", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -1788,6 +1833,21 @@ "summary": "Search for the Advanced Search Config resources.", "description": "", "operationId": "searchAdvancedSearchConfig", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -2314,6 +2374,21 @@ "summary": "Search for the Advanced Search Config Field resources.", "description": "", "operationId": "searchAdvancedSearchConfigField", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -2840,6 +2915,21 @@ "summary": "Search for the Advanced Search Entity Stream resources.", "description": "", "operationId": "searchAdvancedSearchEntityStream", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -3366,6 +3456,21 @@ "summary": "Search for the Advanced Search Entity Stream Filter resources.", "description": "", "operationId": "searchAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -3892,6 +3997,21 @@ "summary": "Search for the Advanced Search Synonym resources.", "description": "", "operationId": "searchAdvancedSearchSynonym", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -4418,6 +4538,21 @@ "summary": "Search for the B2b Business Partner resources.", "description": "", "operationId": "searchB2bBusinessPartner", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -4749,14 +4884,14 @@ } } }, - "/b2b-components-approval-rule": { + "/b2b-components-advanced-product-catalogs": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "List with basic information of B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRuleList", + "summary": "List with basic information of B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "getB2bComponentsAdvancedProductCatalogsList", "parameters": [ { "name": "limit", @@ -4785,7 +4920,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule resources.", + "description": "List of B2b Components Advanced Product Catalogs resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4804,7 +4939,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } ] @@ -4818,16 +4953,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule?limit=25" + "example": "/b2b-components-advanced-product-catalogs?limit=25" }, "last": { - "example": "/b2b-components-approval-rule?limit=25&page=11" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule?limit=25&page=4" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule?limit=25&page=2" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=2" } } } @@ -4848,7 +4983,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4863,11 +4998,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Create a new B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsApprovalRule", + "summary": "Create a new B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "createB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "_response", @@ -4886,14 +5021,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4905,7 +5040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4920,7 +5055,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4936,14 +5071,29 @@ } } }, - "/search/b2b-components-approval-rule": { + "/search/b2b-components-advanced-product-catalogs": { "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" + ], + "summary": "Search for the B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "searchB2bComponentsAdvancedProductCatalogs", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsApprovalRule", "requestBody": { "required": true, "content": { @@ -4956,7 +5106,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRule", + "description": "List of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4970,7 +5120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4988,7 +5138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5005,19 +5155,19 @@ } } }, - "/b2b-components-approval-rule/{id}": { + "/b2b-components-advanced-product-catalogs/{id}": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Detailed information about a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRule", + "summary": "Detailed information about a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "getB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -5027,7 +5177,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -5039,7 +5189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5054,7 +5204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5071,16 +5221,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Delete a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsApprovalRule", + "summary": "Delete a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "deleteB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -5111,16 +5261,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Partially update information about a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsApprovalRule", + "summary": "Partially update information about a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "updateB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -5138,18 +5288,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Partially update information about a B2b Components Advanced Product Catalogs resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -5161,7 +5311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5176,7 +5326,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5195,14 +5345,14 @@ } } }, - "/aggregate/b2b-components-approval-rule": { + "/aggregate/b2b-components-advanced-product-catalogs": { "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Aggregate for the B2b Components Approval Rule resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsApprovalRule", + "summary": "Aggregate for the B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "aggregateB2bComponentsAdvancedProductCatalogs", "requestBody": { "required": true, "content": { @@ -5226,7 +5376,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRule", + "description": "List of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -5240,7 +5390,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5258,7 +5408,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -5275,14 +5425,14 @@ } } }, - "/b2b-components-approval-rule-app-script-condition": { + "/b2b-components-approval-rule": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", + "summary": "List with basic information of B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRuleList", "parameters": [ { "name": "limit", @@ -5311,7 +5461,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule App Script Condition resources.", + "description": "List of B2b Components Approval Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5330,7 +5480,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } ] @@ -5344,16 +5494,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25" + "example": "/b2b-components-approval-rule?limit=25" }, "last": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" + "example": "/b2b-components-approval-rule?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" + "example": "/b2b-components-approval-rule?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" + "example": "/b2b-components-approval-rule?limit=25&page=2" } } } @@ -5374,7 +5524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5389,11 +5539,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Create a new B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsApprovalRule", "parameters": [ { "name": "_response", @@ -5412,14 +5562,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5431,7 +5581,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5446,7 +5596,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5462,14 +5612,29 @@ } } }, - "/search/b2b-components-approval-rule-app-script-condition": { + "/search/b2b-components-approval-rule": { "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" + ], + "summary": "Search for the B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsApprovalRule", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", "requestBody": { "required": true, "content": { @@ -5482,7 +5647,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRuleAppScriptCondition", + "description": "List of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5496,7 +5661,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5514,7 +5679,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5531,19 +5696,19 @@ } } }, - "/b2b-components-approval-rule-app-script-condition/{id}": { + "/b2b-components-approval-rule/{id}": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Detailed information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5553,7 +5718,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5565,7 +5730,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5580,7 +5745,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5597,16 +5762,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Delete a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5637,16 +5802,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5664,18 +5829,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Partially update information about a B2b Components Approval Rule resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5687,7 +5852,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5702,7 +5867,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5721,14 +5886,14 @@ } } }, - "/aggregate/b2b-components-approval-rule-app-script-condition": { + "/aggregate/b2b-components-approval-rule": { "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Aggregate for the B2b Components Approval Rule App Script Condition resources.", + "summary": "Aggregate for the B2b Components Approval Rule resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsApprovalRuleAppScriptCondition", + "operationId": "aggregateB2bComponentsApprovalRule", "requestBody": { "required": true, "content": { @@ -5752,7 +5917,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRuleAppScriptCondition", + "description": "List of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5766,7 +5931,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5784,7 +5949,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5801,14 +5966,14 @@ } } }, - "/b2b-components-organization": { + "/b2b-components-approval-rule-app-script-condition": { "get": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "List with basic information of B2b Components Organization resources.", - "description": "", - "operationId": "getB2bComponentsOrganizationList", + "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", "parameters": [ { "name": "limit", @@ -5837,7 +6002,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Organization resources.", + "description": "List of B2b Components Approval Rule App Script Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5856,7 +6021,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } ] @@ -5870,16 +6035,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-organization?limit=25" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25" }, "last": { - "example": "/b2b-components-organization?limit=25&page=11" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" }, "next": { - "example": "/b2b-components-organization?limit=25&page=4" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" }, "prev": { - "example": "/b2b-components-organization?limit=25&page=2" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" } } } @@ -5900,7 +6065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5915,11 +6080,11 @@ }, "post": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Create a new B2b Components Organization resources.", - "description": "", - "operationId": "createB2bComponentsOrganization", + "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "_response", @@ -5938,14 +6103,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsOrganization", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5957,7 +6122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5972,7 +6137,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5988,14 +6153,29 @@ } } }, - "/search/b2b-components-organization": { + "/search/b2b-components-approval-rule-app-script-condition": { "post": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" + ], + "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Organization resources.", - "description": "", - "operationId": "searchB2bComponentsOrganization", "requestBody": { "required": true, "content": { @@ -6008,7 +6188,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsOrganization", + "description": "List of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -6022,7 +6202,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6040,7 +6220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6057,19 +6237,19 @@ } } }, - "/b2b-components-organization/{id}": { + "/b2b-components-approval-rule-app-script-condition/{id}": { "get": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Detailed information about a B2b Components Organization resource.", - "description": "", - "operationId": "getB2bComponentsOrganization", + "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -6079,7 +6259,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsOrganization", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -6091,7 +6271,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6106,7 +6286,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6123,16 +6303,16 @@ }, "delete": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Delete a B2b Components Organization resource.", - "description": "", - "operationId": "deleteB2bComponentsOrganization", + "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -6163,16 +6343,16 @@ }, "patch": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Partially update information about a B2b Components Organization resource.", - "description": "", - "operationId": "updateB2bComponentsOrganization", + "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -6190,18 +6370,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Organization resource.", + "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsOrganization", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -6213,7 +6393,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6228,7 +6408,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6247,14 +6427,14 @@ } } }, - "/aggregate/b2b-components-organization": { + "/aggregate/b2b-components-approval-rule-app-script-condition": { "post": { "tags": [ - "B2b Components Organization" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Aggregate for the B2b Components Organization resources.", + "summary": "Aggregate for the B2b Components Approval Rule App Script Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsOrganization", + "operationId": "aggregateB2bComponentsApprovalRuleAppScriptCondition", "requestBody": { "required": true, "content": { @@ -6278,7 +6458,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsOrganization", + "description": "List of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -6292,7 +6472,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6310,7 +6490,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -6327,14 +6507,14 @@ } } }, - "/b2b-components-organization-customer-address": { + "/b2b-components-budget": { "get": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "List with basic information of B2b Components Organization Customer Address resources.", - "description": "", - "operationId": "getB2bComponentsOrganizationCustomerAddressList", + "summary": "List with basic information of B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "getB2bComponentsBudgetList", "parameters": [ { "name": "limit", @@ -6363,7 +6543,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Organization Customer Address resources.", + "description": "List of B2b Components Budget resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6382,7 +6562,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } ] @@ -6396,16 +6576,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-organization-customer-address?limit=25" + "example": "/b2b-components-budget?limit=25" }, "last": { - "example": "/b2b-components-organization-customer-address?limit=25&page=11" + "example": "/b2b-components-budget?limit=25&page=11" }, "next": { - "example": "/b2b-components-organization-customer-address?limit=25&page=4" + "example": "/b2b-components-budget?limit=25&page=4" }, "prev": { - "example": "/b2b-components-organization-customer-address?limit=25&page=2" + "example": "/b2b-components-budget?limit=25&page=2" } } } @@ -6426,7 +6606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6441,11 +6621,11 @@ }, "post": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "Create a new B2b Components Organization Customer Address resources.", - "description": "", - "operationId": "createB2bComponentsOrganizationCustomerAddress", + "summary": "Create a new B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "createB2bComponentsBudget", "parameters": [ { "name": "_response", @@ -6464,14 +6644,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsOrganizationCustomerAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6483,7 +6663,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6498,7 +6678,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6514,14 +6694,29 @@ } } }, - "/search/b2b-components-organization-customer-address": { + "/search/b2b-components-budget": { "post": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" + ], + "summary": "Search for the B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "searchB2bComponentsBudget", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Organization Customer Address resources.", - "description": "", - "operationId": "searchB2bComponentsOrganizationCustomerAddress", "requestBody": { "required": true, "content": { @@ -6534,7 +6729,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsOrganizationCustomerAddress", + "description": "List of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6548,7 +6743,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6566,7 +6761,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6583,19 +6778,19 @@ } } }, - "/b2b-components-organization-customer-address/{id}": { + "/b2b-components-budget/{id}": { "get": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "Detailed information about a B2b Components Organization Customer Address resource.", - "description": "", - "operationId": "getB2bComponentsOrganizationCustomerAddress", + "summary": "Detailed information about a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "getB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization_customer_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6605,7 +6800,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsOrganizationCustomerAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6617,7 +6812,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6632,7 +6827,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6649,16 +6844,16 @@ }, "delete": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "Delete a B2b Components Organization Customer Address resource.", - "description": "", - "operationId": "deleteB2bComponentsOrganizationCustomerAddress", + "summary": "Delete a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "deleteB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization_customer_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6689,16 +6884,16 @@ }, "patch": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "Partially update information about a B2b Components Organization Customer Address resource.", - "description": "", - "operationId": "updateB2bComponentsOrganizationCustomerAddress", + "summary": "Partially update information about a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "updateB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_organization_customer_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6716,18 +6911,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Organization Customer Address resource.", + "description": "Partially update information about a B2b Components Budget resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsOrganizationCustomerAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6739,7 +6934,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6754,7 +6949,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6773,14 +6968,14 @@ } } }, - "/aggregate/b2b-components-organization-customer-address": { + "/aggregate/b2b-components-budget": { "post": { "tags": [ - "B2b Components Organization Customer Address" + "B2b Components Budget" ], - "summary": "Aggregate for the B2b Components Organization Customer Address resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsOrganizationCustomerAddress", + "summary": "Aggregate for the B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "aggregateB2bComponentsBudget", "requestBody": { "required": true, "content": { @@ -6804,7 +6999,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsOrganizationCustomerAddress", + "description": "List of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6818,7 +7013,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6836,7 +7031,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6853,14 +7048,14 @@ } } }, - "/b2b-components-pending-order": { + "/b2b-components-employee-wishlist": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "List with basic information of B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderList", + "summary": "List with basic information of B2b Components Employee Wishlist resources.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlistList", "parameters": [ { "name": "limit", @@ -6889,7 +7084,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order resources.", + "description": "List of B2b Components Employee Wishlist resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6908,7 +7103,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } ] @@ -6922,16 +7117,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order?limit=25" + "example": "/b2b-components-employee-wishlist?limit=25" }, "last": { - "example": "/b2b-components-pending-order?limit=25&page=11" + "example": "/b2b-components-employee-wishlist?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order?limit=25&page=4" + "example": "/b2b-components-employee-wishlist?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order?limit=25&page=2" + "example": "/b2b-components-employee-wishlist?limit=25&page=2" } } } @@ -6952,7 +7147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6967,11 +7162,11 @@ }, "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "Create a new B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrder", + "summary": "Create a new B2b Components Employee Wishlist resources.", + "description": "", + "operationId": "createB2bComponentsEmployeeWishlist", "parameters": [ { "name": "_response", @@ -6990,14 +7185,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -7009,7 +7204,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7024,7 +7219,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7040,14 +7235,29 @@ } } }, - "/search/b2b-components-pending-order": { + "/search/b2b-components-employee-wishlist": { "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" + ], + "summary": "Search for the B2b Components Employee Wishlist resources.", + "description": "", + "operationId": "searchB2bComponentsEmployeeWishlist", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrder", "requestBody": { "required": true, "content": { @@ -7060,7 +7270,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrder", + "description": "List of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -7074,7 +7284,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7092,7 +7302,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7109,19 +7319,19 @@ } } }, - "/b2b-components-pending-order/{id}": { + "/b2b-components-employee-wishlist/{id}": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "Detailed information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrder", + "summary": "Detailed information about a B2b Components Employee Wishlist resource.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -7131,7 +7341,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -7143,7 +7353,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7158,7 +7368,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7175,16 +7385,16 @@ }, "delete": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "Delete a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrder", + "summary": "Delete a B2b Components Employee Wishlist resource.", + "description": "", + "operationId": "deleteB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -7215,16 +7425,16 @@ }, "patch": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "Partially update information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrder", + "summary": "Partially update information about a B2b Components Employee Wishlist resource.", + "description": "", + "operationId": "updateB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -7242,18 +7452,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order resource.", + "description": "Partially update information about a B2b Components Employee Wishlist resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -7265,7 +7475,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7280,7 +7490,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7299,14 +7509,14 @@ } } }, - "/aggregate/b2b-components-pending-order": { + "/aggregate/b2b-components-employee-wishlist": { "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Employee Wishlist" ], - "summary": "Aggregate for the B2b Components Pending Order resources.", + "summary": "Aggregate for the B2b Components Employee Wishlist resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsPendingOrder", + "operationId": "aggregateB2bComponentsEmployeeWishlist", "requestBody": { "required": true, "content": { @@ -7330,7 +7540,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrder", + "description": "List of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -7344,7 +7554,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7362,7 +7572,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -7379,14 +7589,14 @@ } } }, - "/b2b-components-pending-order-address": { + "/b2b-components-employee-wishlist-product": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "List with basic information of B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddressList", + "summary": "List with basic information of B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlistProductList", "parameters": [ { "name": "limit", @@ -7415,7 +7625,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order Address resources.", + "description": "List of B2b Components Employee Wishlist Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7434,7 +7644,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } ] @@ -7448,16 +7658,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order-address?limit=25" + "example": "/b2b-components-employee-wishlist-product?limit=25" }, "last": { - "example": "/b2b-components-pending-order-address?limit=25&page=11" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order-address?limit=25&page=4" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order-address?limit=25&page=2" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=2" } } } @@ -7478,7 +7688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7493,11 +7703,11 @@ }, "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "Create a new B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrderAddress", + "summary": "Create a new B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "createB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "_response", @@ -7516,14 +7726,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7535,7 +7745,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7550,7 +7760,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7566,14 +7776,29 @@ } } }, - "/search/b2b-components-pending-order-address": { + "/search/b2b-components-employee-wishlist-product": { "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" + ], + "summary": "Search for the B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "searchB2bComponentsEmployeeWishlistProduct", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrderAddress", "requestBody": { "required": true, "content": { @@ -7586,7 +7811,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrderAddress", + "description": "List of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7600,7 +7825,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7618,7 +7843,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7635,19 +7860,19 @@ } } }, - "/b2b-components-pending-order-address/{id}": { + "/b2b-components-employee-wishlist-product/{id}": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "Detailed information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddress", + "summary": "Detailed information about a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7657,7 +7882,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7669,7 +7894,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7684,7 +7909,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7701,16 +7926,16 @@ }, "delete": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "Delete a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrderAddress", + "summary": "Delete a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "deleteB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7741,16 +7966,16 @@ }, "patch": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "Partially update information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrderAddress", + "summary": "Partially update information about a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "updateB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7768,18 +7993,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Partially update information about a B2b Components Employee Wishlist Product resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7791,7 +8016,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7806,7 +8031,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7825,14 +8050,14 @@ } } }, - "/aggregate/b2b-components-pending-order-address": { + "/aggregate/b2b-components-employee-wishlist-product": { "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Employee Wishlist Product" ], - "summary": "Aggregate for the B2b Components Pending Order Address resources.", + "summary": "Aggregate for the B2b Components Employee Wishlist Product resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsPendingOrderAddress", + "operationId": "aggregateB2bComponentsEmployeeWishlistProduct", "requestBody": { "required": true, "content": { @@ -7856,7 +8081,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrderAddress", + "description": "List of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7870,7 +8095,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7888,7 +8113,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7905,14 +8130,14 @@ } } }, - "/b2b-components-role": { + "/b2b-components-organization": { "get": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "List with basic information of B2b Components Role resources.", + "summary": "List with basic information of B2b Components Organization resources.", "description": "", - "operationId": "getB2bComponentsRoleList", + "operationId": "getB2bComponentsOrganizationList", "parameters": [ { "name": "limit", @@ -7941,7 +8166,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Role resources.", + "description": "List of B2b Components Organization resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7960,7 +8185,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } ] @@ -7974,16 +8199,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-role?limit=25" + "example": "/b2b-components-organization?limit=25" }, "last": { - "example": "/b2b-components-role?limit=25&page=11" + "example": "/b2b-components-organization?limit=25&page=11" }, "next": { - "example": "/b2b-components-role?limit=25&page=4" + "example": "/b2b-components-organization?limit=25&page=4" }, "prev": { - "example": "/b2b-components-role?limit=25&page=2" + "example": "/b2b-components-organization?limit=25&page=2" } } } @@ -8004,7 +8229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8019,11 +8244,11 @@ }, "post": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Create a new B2b Components Role resources.", + "summary": "Create a new B2b Components Organization resources.", "description": "", - "operationId": "createB2bComponentsRole", + "operationId": "createB2bComponentsOrganization", "parameters": [ { "name": "_response", @@ -8042,14 +8267,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -8061,7 +8286,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8076,7 +8301,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8092,14 +8317,29 @@ } } }, - "/search/b2b-components-role": { + "/search/b2b-components-organization": { "post": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Search for the B2b Components Role resources.", + "summary": "Search for the B2b Components Organization resources.", "description": "", - "operationId": "searchB2bComponentsRole", + "operationId": "searchB2bComponentsOrganization", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -8112,7 +8352,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsRole", + "description": "List of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -8126,7 +8366,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8144,7 +8384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8161,19 +8401,19 @@ } } }, - "/b2b-components-role/{id}": { + "/b2b-components-organization/{id}": { "get": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Detailed information about a B2b Components Role resource.", + "summary": "Detailed information about a B2b Components Organization resource.", "description": "", - "operationId": "getB2bComponentsRole", + "operationId": "getB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -8183,7 +8423,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -8195,7 +8435,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8210,7 +8450,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8227,16 +8467,16 @@ }, "delete": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Delete a B2b Components Role resource.", + "summary": "Delete a B2b Components Organization resource.", "description": "", - "operationId": "deleteB2bComponentsRole", + "operationId": "deleteB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -8267,16 +8507,16 @@ }, "patch": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Partially update information about a B2b Components Role resource.", + "summary": "Partially update information about a B2b Components Organization resource.", "description": "", - "operationId": "updateB2bComponentsRole", + "operationId": "updateB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -8294,18 +8534,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Role resource.", + "description": "Partially update information about a B2b Components Organization resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -8317,7 +8557,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8332,7 +8572,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8351,14 +8591,14 @@ } } }, - "/aggregate/b2b-components-role": { + "/aggregate/b2b-components-organization": { "post": { "tags": [ - "B2b Components Role" + "B2b Components Organization" ], - "summary": "Aggregate for the B2b Components Role resources.", + "summary": "Aggregate for the B2b Components Organization resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsRole", + "operationId": "aggregateB2bComponentsOrganization", "requestBody": { "required": true, "content": { @@ -8382,7 +8622,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsRole", + "description": "List of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -8396,7 +8636,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8414,7 +8654,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -8431,14 +8671,14 @@ } } }, - "/b2b-components-shopping-list": { + "/b2b-components-organization-customer-address": { "get": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "List with basic information of B2b Components Shopping List resources.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingListList", + "summary": "List with basic information of B2b Components Organization Customer Address resources.", + "description": "", + "operationId": "getB2bComponentsOrganizationCustomerAddressList", "parameters": [ { "name": "limit", @@ -8467,7 +8707,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List resources.", + "description": "List of B2b Components Organization Customer Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8486,7 +8726,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } ] @@ -8500,16 +8740,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list?limit=25" + "example": "/b2b-components-organization-customer-address?limit=25" }, "last": { - "example": "/b2b-components-shopping-list?limit=25&page=11" + "example": "/b2b-components-organization-customer-address?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list?limit=25&page=4" + "example": "/b2b-components-organization-customer-address?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list?limit=25&page=2" + "example": "/b2b-components-organization-customer-address?limit=25&page=2" } } } @@ -8530,7 +8770,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8545,11 +8785,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "Create a new B2b Components Shopping List resources.", - "description": "Available since: 6.6.2.0", - "operationId": "createB2bComponentsShoppingList", + "summary": "Create a new B2b Components Organization Customer Address resources.", + "description": "", + "operationId": "createB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "_response", @@ -8568,14 +8808,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -8587,7 +8827,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8602,7 +8842,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8618,14 +8858,29 @@ } } }, - "/search/b2b-components-shopping-list": { + "/search/b2b-components-organization-customer-address": { "post": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" + ], + "summary": "Search for the B2b Components Organization Customer Address resources.", + "description": "", + "operationId": "searchB2bComponentsOrganizationCustomerAddress", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Shopping List resources.", - "description": "Available since: 6.6.2.0", - "operationId": "searchB2bComponentsShoppingList", "requestBody": { "required": true, "content": { @@ -8638,7 +8893,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingList", + "description": "List of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -8652,7 +8907,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8670,7 +8925,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8687,19 +8942,19 @@ } } }, - "/b2b-components-shopping-list/{id}": { + "/b2b-components-organization-customer-address/{id}": { "get": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "Detailed information about a B2b Components Shopping List resource.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingList", + "summary": "Detailed information about a B2b Components Organization Customer Address resource.", + "description": "", + "operationId": "getB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -8709,7 +8964,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -8721,7 +8976,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8736,7 +8991,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8753,16 +9008,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "Delete a B2b Components Shopping List resource.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingList", + "summary": "Delete a B2b Components Organization Customer Address resource.", + "description": "", + "operationId": "deleteB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -8793,16 +9048,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "Partially update information about a B2b Components Shopping List resource.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingList", + "summary": "Partially update information about a B2b Components Organization Customer Address resource.", + "description": "", + "operationId": "updateB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -8820,18 +9075,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List resource.", + "description": "Partially update information about a B2b Components Organization Customer Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -8843,7 +9098,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8858,7 +9113,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8877,14 +9132,14 @@ } } }, - "/aggregate/b2b-components-shopping-list": { + "/aggregate/b2b-components-organization-customer-address": { "post": { "tags": [ - "B2b Components Shopping List" + "B2b Components Organization Customer Address" ], - "summary": "Aggregate for the B2b Components Shopping List resources.", + "summary": "Aggregate for the B2b Components Organization Customer Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsShoppingList", + "operationId": "aggregateB2bComponentsOrganizationCustomerAddress", "requestBody": { "required": true, "content": { @@ -8908,7 +9163,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingList", + "description": "List of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -8922,7 +9177,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8940,7 +9195,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -8957,14 +9212,14 @@ } } }, - "/b2b-components-shopping-list-line-item": { + "/b2b-components-pending-order": { "get": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "List with basic information of B2b Components Shopping List Line Item resources.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingListLineItemList", + "summary": "List with basic information of B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderList", "parameters": [ { "name": "limit", @@ -8993,7 +9248,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List Line Item resources.", + "description": "List of B2b Components Pending Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9012,7 +9267,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } ] @@ -9026,16 +9281,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list-line-item?limit=25" + "example": "/b2b-components-pending-order?limit=25" }, "last": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" + "example": "/b2b-components-pending-order?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" + "example": "/b2b-components-pending-order?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" + "example": "/b2b-components-pending-order?limit=25&page=2" } } } @@ -9056,7 +9311,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9071,11 +9326,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "Create a new B2b Components Shopping List Line Item resources.", - "description": "Available since: 6.6.2.0", - "operationId": "createB2bComponentsShoppingListLineItem", + "summary": "Create a new B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrder", "parameters": [ { "name": "_response", @@ -9094,14 +9349,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -9113,7 +9368,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9128,7 +9383,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9144,14 +9399,29 @@ } } }, - "/search/b2b-components-shopping-list-line-item": { + "/search/b2b-components-pending-order": { "post": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" + ], + "summary": "Search for the B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrder", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Components Shopping List Line Item resources.", - "description": "Available since: 6.6.2.0", - "operationId": "searchB2bComponentsShoppingListLineItem", "requestBody": { "required": true, "content": { @@ -9164,7 +9434,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingListLineItem", + "description": "List of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -9178,7 +9448,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9196,7 +9466,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9213,19 +9483,19 @@ } } }, - "/b2b-components-shopping-list-line-item/{id}": { + "/b2b-components-pending-order/{id}": { "get": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "Detailed information about a B2b Components Shopping List Line Item resource.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingListLineItem", + "summary": "Detailed information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -9235,7 +9505,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -9247,7 +9517,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9262,7 +9532,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9279,16 +9549,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "Delete a B2b Components Shopping List Line Item resource.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingListLineItem", + "summary": "Delete a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -9319,16 +9589,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "Partially update information about a B2b Components Shopping List Line Item resource.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingListLineItem", + "summary": "Partially update information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -9346,18 +9616,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List Line Item resource.", + "description": "Partially update information about a B2b Components Pending Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -9369,7 +9639,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9384,7 +9654,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9403,14 +9673,14 @@ } } }, - "/aggregate/b2b-components-shopping-list-line-item": { + "/aggregate/b2b-components-pending-order": { "post": { "tags": [ - "B2b Components Shopping List Line Item" + "B2b Components Pending Order" ], - "summary": "Aggregate for the B2b Components Shopping List Line Item resources.", + "summary": "Aggregate for the B2b Components Pending Order resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bComponentsShoppingListLineItem", + "operationId": "aggregateB2bComponentsPendingOrder", "requestBody": { "required": true, "content": { @@ -9434,7 +9704,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingListLineItem", + "description": "List of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -9448,7 +9718,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9466,7 +9736,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -9483,14 +9753,14 @@ } } }, - "/b2b-employee": { + "/b2b-components-pending-order-address": { "get": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "List with basic information of B2b Employee resources.", - "description": "", - "operationId": "getB2bEmployeeList", + "summary": "List with basic information of B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddressList", "parameters": [ { "name": "limit", @@ -9519,7 +9789,7 @@ ], "responses": { "200": { - "description": "List of B2b Employee resources.", + "description": "List of B2b Components Pending Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9538,7 +9808,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } ] @@ -9552,16 +9822,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-employee?limit=25" + "example": "/b2b-components-pending-order-address?limit=25" }, "last": { - "example": "/b2b-employee?limit=25&page=11" + "example": "/b2b-components-pending-order-address?limit=25&page=11" }, "next": { - "example": "/b2b-employee?limit=25&page=4" + "example": "/b2b-components-pending-order-address?limit=25&page=4" }, "prev": { - "example": "/b2b-employee?limit=25&page=2" + "example": "/b2b-components-pending-order-address?limit=25&page=2" } } } @@ -9582,7 +9852,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9597,11 +9867,11 @@ }, "post": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "Create a new B2b Employee resources.", - "description": "", - "operationId": "createB2bEmployee", + "summary": "Create a new B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrderAddress", "parameters": [ { "name": "_response", @@ -9620,14 +9890,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9639,7 +9909,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9654,7 +9924,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9670,14 +9940,29 @@ } } }, - "/search/b2b-employee": { + "/search/b2b-components-pending-order-address": { "post": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" + ], + "summary": "Search for the B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrderAddress", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Employee resources.", - "description": "", - "operationId": "searchB2bEmployee", "requestBody": { "required": true, "content": { @@ -9690,7 +9975,7 @@ }, "responses": { "200": { - "description": "List of B2bEmployee", + "description": "List of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9704,7 +9989,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9722,7 +10007,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9739,19 +10024,19 @@ } } }, - "/b2b-employee/{id}": { + "/b2b-components-pending-order-address/{id}": { "get": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "Detailed information about a B2b Employee resource.", - "description": "", - "operationId": "getB2bEmployee", + "summary": "Detailed information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -9761,7 +10046,7 @@ ], "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9773,7 +10058,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9788,7 +10073,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9805,16 +10090,16 @@ }, "delete": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "Delete a B2b Employee resource.", - "description": "", - "operationId": "deleteB2bEmployee", + "summary": "Delete a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -9845,16 +10130,16 @@ }, "patch": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "Partially update information about a B2b Employee resource.", - "description": "", - "operationId": "updateB2bEmployee", + "summary": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -9872,18 +10157,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Employee resource.", + "description": "Partially update information about a B2b Components Pending Order Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9895,7 +10180,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9910,7 +10195,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9929,14 +10214,14 @@ } } }, - "/aggregate/b2b-employee": { + "/aggregate/b2b-components-pending-order-address": { "post": { "tags": [ - "B2b Employee" + "B2b Components Pending Order Address" ], - "summary": "Aggregate for the B2b Employee resources.", + "summary": "Aggregate for the B2b Components Pending Order Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bEmployee", + "operationId": "aggregateB2bComponentsPendingOrderAddress", "requestBody": { "required": true, "content": { @@ -9960,7 +10245,7 @@ }, "responses": { "200": { - "description": "List of B2bEmployee", + "description": "List of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9974,7 +10259,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -9992,7 +10277,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10009,14 +10294,14 @@ } } }, - "/b2b-order-employee": { + "/b2b-components-role": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "List with basic information of B2b Order Employee resources.", + "summary": "List with basic information of B2b Components Role resources.", "description": "", - "operationId": "getB2bOrderEmployeeList", + "operationId": "getB2bComponentsRoleList", "parameters": [ { "name": "limit", @@ -10045,7 +10330,7 @@ ], "responses": { "200": { - "description": "List of B2b Order Employee resources.", + "description": "List of B2b Components Role resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10064,7 +10349,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } ] @@ -10078,16 +10363,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-order-employee?limit=25" + "example": "/b2b-components-role?limit=25" }, "last": { - "example": "/b2b-order-employee?limit=25&page=11" + "example": "/b2b-components-role?limit=25&page=11" }, "next": { - "example": "/b2b-order-employee?limit=25&page=4" + "example": "/b2b-components-role?limit=25&page=4" }, "prev": { - "example": "/b2b-order-employee?limit=25&page=2" + "example": "/b2b-components-role?limit=25&page=2" } } } @@ -10108,7 +10393,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10123,11 +10408,11 @@ }, "post": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Create a new B2b Order Employee resources.", + "summary": "Create a new B2b Components Role resources.", "description": "", - "operationId": "createB2bOrderEmployee", + "operationId": "createB2bComponentsRole", "parameters": [ { "name": "_response", @@ -10146,14 +10431,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -10165,7 +10450,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10180,7 +10465,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10196,14 +10481,29 @@ } } }, - "/search/b2b-order-employee": { + "/search/b2b-components-role": { "post": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Search for the B2b Order Employee resources.", + "summary": "Search for the B2b Components Role resources.", "description": "", - "operationId": "searchB2bOrderEmployee", + "operationId": "searchB2bComponentsRole", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -10216,7 +10516,7 @@ }, "responses": { "200": { - "description": "List of B2bOrderEmployee", + "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -10230,7 +10530,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10248,7 +10548,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10265,19 +10565,19 @@ } } }, - "/b2b-order-employee/{id}": { + "/b2b-components-role/{id}": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Detailed information about a B2b Order Employee resource.", + "summary": "Detailed information about a B2b Components Role resource.", "description": "", - "operationId": "getB2bOrderEmployee", + "operationId": "getB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -10287,7 +10587,7 @@ ], "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -10299,7 +10599,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10314,7 +10614,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10331,16 +10631,16 @@ }, "delete": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Delete a B2b Order Employee resource.", + "summary": "Delete a B2b Components Role resource.", "description": "", - "operationId": "deleteB2bOrderEmployee", + "operationId": "deleteB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -10371,16 +10671,16 @@ }, "patch": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Partially update information about a B2b Order Employee resource.", + "summary": "Partially update information about a B2b Components Role resource.", "description": "", - "operationId": "updateB2bOrderEmployee", + "operationId": "updateB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -10398,18 +10698,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Order Employee resource.", + "description": "Partially update information about a B2b Components Role resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -10421,7 +10721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10436,7 +10736,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10455,14 +10755,14 @@ } } }, - "/aggregate/b2b-order-employee": { + "/aggregate/b2b-components-role": { "post": { "tags": [ - "B2b Order Employee" + "B2b Components Role" ], - "summary": "Aggregate for the B2b Order Employee resources.", + "summary": "Aggregate for the B2b Components Role resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bOrderEmployee", + "operationId": "aggregateB2bComponentsRole", "requestBody": { "required": true, "content": { @@ -10486,7 +10786,7 @@ }, "responses": { "200": { - "description": "List of B2bOrderEmployee", + "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -10500,7 +10800,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10518,7 +10818,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -10535,14 +10835,14 @@ } } }, - "/b2b-permission": { + "/b2b-components-shopping-list": { "get": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "List with basic information of B2b Permission resources.", - "description": "", - "operationId": "getB2bPermissionList", + "summary": "List with basic information of B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListList", "parameters": [ { "name": "limit", @@ -10571,7 +10871,7 @@ ], "responses": { "200": { - "description": "List of B2b Permission resources.", + "description": "List of B2b Components Shopping List resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10590,7 +10890,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } ] @@ -10604,16 +10904,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-permission?limit=25" + "example": "/b2b-components-shopping-list?limit=25" }, "last": { - "example": "/b2b-permission?limit=25&page=11" + "example": "/b2b-components-shopping-list?limit=25&page=11" }, "next": { - "example": "/b2b-permission?limit=25&page=4" + "example": "/b2b-components-shopping-list?limit=25&page=4" }, "prev": { - "example": "/b2b-permission?limit=25&page=2" + "example": "/b2b-components-shopping-list?limit=25&page=2" } } } @@ -10634,7 +10934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10649,11 +10949,11 @@ }, "post": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "Create a new B2b Permission resources.", - "description": "", - "operationId": "createB2bPermission", + "summary": "Create a new B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "createB2bComponentsShoppingList", "parameters": [ { "name": "_response", @@ -10672,14 +10972,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -10691,7 +10991,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10706,7 +11006,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10722,14 +11022,29 @@ } } }, - "/search/b2b-permission": { + "/search/b2b-components-shopping-list": { "post": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" + ], + "summary": "Search for the B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "searchB2bComponentsShoppingList", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the B2b Permission resources.", - "description": "", - "operationId": "searchB2bPermission", "requestBody": { "required": true, "content": { @@ -10742,7 +11057,7 @@ }, "responses": { "200": { - "description": "List of B2bPermission", + "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -10756,7 +11071,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10774,7 +11089,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10791,19 +11106,19 @@ } } }, - "/b2b-permission/{id}": { + "/b2b-components-shopping-list/{id}": { "get": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "Detailed information about a B2b Permission resource.", - "description": "", - "operationId": "getB2bPermission", + "summary": "Detailed information about a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -10813,7 +11128,7 @@ ], "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -10825,7 +11140,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10840,7 +11155,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10857,16 +11172,16 @@ }, "delete": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "Delete a B2b Permission resource.", - "description": "", - "operationId": "deleteB2bPermission", + "summary": "Delete a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -10897,16 +11212,16 @@ }, "patch": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "Partially update information about a B2b Permission resource.", - "description": "", - "operationId": "updateB2bPermission", + "summary": "Partially update information about a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -10924,18 +11239,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Permission resource.", + "description": "Partially update information about a B2b Components Shopping List resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -10947,7 +11262,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10962,7 +11277,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -10981,14 +11296,14 @@ } } }, - "/aggregate/b2b-permission": { + "/aggregate/b2b-components-shopping-list": { "post": { "tags": [ - "B2b Permission" + "B2b Components Shopping List" ], - "summary": "Aggregate for the B2b Permission resources.", + "summary": "Aggregate for the B2b Components Shopping List resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateB2bPermission", + "operationId": "aggregateB2bComponentsShoppingList", "requestBody": { "required": true, "content": { @@ -11012,7 +11327,7 @@ }, "responses": { "200": { - "description": "List of B2bPermission", + "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -11026,7 +11341,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11044,7 +11359,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11061,14 +11376,14 @@ } } }, - "/custom-price": { + "/b2b-components-shopping-list-line-item": { "get": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "List with basic information of Custom Price resources.", - "description": "", - "operationId": "getCustomPriceList", + "summary": "List with basic information of B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItemList", "parameters": [ { "name": "limit", @@ -11097,7 +11412,7 @@ ], "responses": { "200": { - "description": "List of Custom Price resources.", + "description": "List of B2b Components Shopping List Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11116,7 +11431,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } ] @@ -11130,16 +11445,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-price?limit=25" + "example": "/b2b-components-shopping-list-line-item?limit=25" }, "last": { - "example": "/custom-price?limit=25&page=11" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" }, "next": { - "example": "/custom-price?limit=25&page=4" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" }, "prev": { - "example": "/custom-price?limit=25&page=2" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" } } } @@ -11160,7 +11475,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11175,11 +11490,11 @@ }, "post": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "Create a new Custom Price resources.", - "description": "", - "operationId": "createCustomPrice", + "summary": "Create a new B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "createB2bComponentsShoppingListLineItem", "parameters": [ { "name": "_response", @@ -11198,14 +11513,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -11217,7 +11532,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11232,7 +11547,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11248,14 +11563,29 @@ } } }, - "/search/custom-price": { + "/search/b2b-components-shopping-list-line-item": { "post": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" + ], + "summary": "Search for the B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "searchB2bComponentsShoppingListLineItem", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Custom Price resources.", - "description": "", - "operationId": "searchCustomPrice", "requestBody": { "required": true, "content": { @@ -11268,7 +11598,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -11282,7 +11612,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11300,7 +11630,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11317,19 +11647,19 @@ } } }, - "/custom-price/{id}": { + "/b2b-components-shopping-list-line-item/{id}": { "get": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "Detailed information about a Custom Price resource.", - "description": "", - "operationId": "getCustomPrice", + "summary": "Detailed information about a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -11339,7 +11669,7 @@ ], "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -11351,7 +11681,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11366,7 +11696,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11383,16 +11713,16 @@ }, "delete": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "Delete a Custom Price resource.", - "description": "", - "operationId": "deleteCustomPrice", + "summary": "Delete a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -11423,16 +11753,16 @@ }, "patch": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "Partially update information about a Custom Price resource.", - "description": "", - "operationId": "updateCustomPrice", + "summary": "Partially update information about a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -11450,18 +11780,18 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Price resource.", + "description": "Partially update information about a B2b Components Shopping List Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -11473,7 +11803,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11488,7 +11818,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11507,14 +11837,14 @@ } } }, - "/aggregate/custom-price": { + "/aggregate/b2b-components-shopping-list-line-item": { "post": { "tags": [ - "Custom Price" + "B2b Components Shopping List Line Item" ], - "summary": "Aggregate for the Custom Price resources.", + "summary": "Aggregate for the B2b Components Shopping List Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomPrice", + "operationId": "aggregateB2bComponentsShoppingListLineItem", "requestBody": { "required": true, "content": { @@ -11538,7 +11868,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -11552,7 +11882,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11570,7 +11900,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -11587,14 +11917,14 @@ } } }, - "/customer-specific-features": { + "/b2b-components-subscription-employee": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "List with basic information of Customer Specific Features resources.", + "summary": "List with basic information of B2b Components Subscription Employee resources.", "description": "", - "operationId": "getCustomerSpecificFeaturesList", + "operationId": "getB2bComponentsSubscriptionEmployeeList", "parameters": [ { "name": "limit", @@ -11623,7 +11953,7 @@ ], "responses": { "200": { - "description": "List of Customer Specific Features resources.", + "description": "List of B2b Components Subscription Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11642,7 +11972,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } ] @@ -11656,16 +11986,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-specific-features?limit=25" + "example": "/b2b-components-subscription-employee?limit=25" }, "last": { - "example": "/customer-specific-features?limit=25&page=11" + "example": "/b2b-components-subscription-employee?limit=25&page=11" }, "next": { - "example": "/customer-specific-features?limit=25&page=4" + "example": "/b2b-components-subscription-employee?limit=25&page=4" }, "prev": { - "example": "/customer-specific-features?limit=25&page=2" + "example": "/b2b-components-subscription-employee?limit=25&page=2" } } } @@ -11686,7 +12016,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11701,11 +12031,11 @@ }, "post": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Create a new Customer Specific Features resources.", + "summary": "Create a new B2b Components Subscription Employee resources.", "description": "", - "operationId": "createCustomerSpecificFeatures", + "operationId": "createB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "_response", @@ -11724,14 +12054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -11743,7 +12073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11758,7 +12088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11774,14 +12104,29 @@ } } }, - "/search/customer-specific-features": { + "/search/b2b-components-subscription-employee": { "post": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Search for the Customer Specific Features resources.", + "summary": "Search for the B2b Components Subscription Employee resources.", "description": "", - "operationId": "searchCustomerSpecificFeatures", + "operationId": "searchB2bComponentsSubscriptionEmployee", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -11794,7 +12139,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -11808,7 +12153,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11826,7 +12171,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11843,19 +12188,19 @@ } } }, - "/customer-specific-features/{id}": { + "/b2b-components-subscription-employee/{id}": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Detailed information about a Customer Specific Features resource.", + "summary": "Detailed information about a B2b Components Subscription Employee resource.", "description": "", - "operationId": "getCustomerSpecificFeatures", + "operationId": "getB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -11865,7 +12210,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -11877,7 +12222,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11892,7 +12237,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -11909,16 +12254,16 @@ }, "delete": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Delete a Customer Specific Features resource.", + "summary": "Delete a B2b Components Subscription Employee resource.", "description": "", - "operationId": "deleteCustomerSpecificFeatures", + "operationId": "deleteB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -11949,16 +12294,16 @@ }, "patch": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Partially update information about a Customer Specific Features resource.", + "summary": "Partially update information about a B2b Components Subscription Employee resource.", "description": "", - "operationId": "updateCustomerSpecificFeatures", + "operationId": "updateB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -11976,18 +12321,18 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Specific Features resource.", + "description": "Partially update information about a B2b Components Subscription Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -11999,7 +12344,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12014,7 +12359,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12033,14 +12378,14 @@ } } }, - "/aggregate/customer-specific-features": { + "/aggregate/b2b-components-subscription-employee": { "post": { "tags": [ - "Customer Specific Features" + "B2b Components Subscription Employee" ], - "summary": "Aggregate for the Customer Specific Features resources.", + "summary": "Aggregate for the B2b Components Subscription Employee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerSpecificFeatures", + "operationId": "aggregateB2bComponentsSubscriptionEmployee", "requestBody": { "required": true, "content": { @@ -12064,7 +12409,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12078,7 +12423,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12096,7 +12441,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12113,14 +12458,14 @@ } } }, - "/measurement-display-unit": { + "/b2b-employee": { "get": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "List with basic information of Measurement Display Unit resources.", - "description": "Available since: 6.7.1.0", - "operationId": "getMeasurementDisplayUnitList", + "summary": "List with basic information of B2b Employee resources.", + "description": "", + "operationId": "getB2bEmployeeList", "parameters": [ { "name": "limit", @@ -12149,7 +12494,7 @@ ], "responses": { "200": { - "description": "List of Measurement Display Unit resources.", + "description": "List of B2b Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12168,7 +12513,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } ] @@ -12182,16 +12527,16 @@ "type": "object", "properties": { "first": { - "example": "/measurement-display-unit?limit=25" + "example": "/b2b-employee?limit=25" }, "last": { - "example": "/measurement-display-unit?limit=25&page=11" + "example": "/b2b-employee?limit=25&page=11" }, "next": { - "example": "/measurement-display-unit?limit=25&page=4" + "example": "/b2b-employee?limit=25&page=4" }, "prev": { - "example": "/measurement-display-unit?limit=25&page=2" + "example": "/b2b-employee?limit=25&page=2" } } } @@ -12212,7 +12557,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12227,11 +12572,11 @@ }, "post": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "Create a new Measurement Display Unit resources.", - "description": "Available since: 6.7.1.0", - "operationId": "createMeasurementDisplayUnit", + "summary": "Create a new B2b Employee resources.", + "description": "", + "operationId": "createB2bEmployee", "parameters": [ { "name": "_response", @@ -12250,14 +12595,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of MeasurementDisplayUnit", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12269,7 +12614,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12284,7 +12629,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12300,14 +12645,29 @@ } } }, - "/search/measurement-display-unit": { + "/search/b2b-employee": { "post": { "tags": [ - "Measurement Display Unit" + "B2b Employee" + ], + "summary": "Search for the B2b Employee resources.", + "description": "", + "operationId": "searchB2bEmployee", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Measurement Display Unit resources.", - "description": "Available since: 6.7.1.0", - "operationId": "searchMeasurementDisplayUnit", "requestBody": { "required": true, "content": { @@ -12320,7 +12680,7 @@ }, "responses": { "200": { - "description": "List of MeasurementDisplayUnit", + "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12334,7 +12694,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12352,7 +12712,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12369,19 +12729,19 @@ } } }, - "/measurement-display-unit/{id}": { + "/b2b-employee/{id}": { "get": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "Detailed information about a Measurement Display Unit resource.", - "description": "Available since: 6.7.1.0", - "operationId": "getMeasurementDisplayUnit", + "summary": "Detailed information about a B2b Employee resource.", + "description": "", + "operationId": "getB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_display_unit", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -12391,7 +12751,7 @@ ], "responses": { "200": { - "description": "Detail of MeasurementDisplayUnit", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12403,7 +12763,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12418,7 +12778,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12435,16 +12795,16 @@ }, "delete": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "Delete a Measurement Display Unit resource.", - "description": "Available since: 6.7.1.0", - "operationId": "deleteMeasurementDisplayUnit", + "summary": "Delete a B2b Employee resource.", + "description": "", + "operationId": "deleteB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_display_unit", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -12475,16 +12835,16 @@ }, "patch": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "Partially update information about a Measurement Display Unit resource.", - "description": "Available since: 6.7.1.0", - "operationId": "updateMeasurementDisplayUnit", + "summary": "Partially update information about a B2b Employee resource.", + "description": "", + "operationId": "updateB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_display_unit", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -12502,18 +12862,18 @@ } ], "requestBody": { - "description": "Partially update information about a Measurement Display Unit resource.", + "description": "Partially update information about a B2b Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of MeasurementDisplayUnit", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12525,7 +12885,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12540,7 +12900,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12559,14 +12919,14 @@ } } }, - "/aggregate/measurement-display-unit": { + "/aggregate/b2b-employee": { "post": { "tags": [ - "Measurement Display Unit" + "B2b Employee" ], - "summary": "Aggregate for the Measurement Display Unit resources.", - "description": "Available since: 6.7.1.0", - "operationId": "aggregateMeasurementDisplayUnit", + "summary": "Aggregate for the B2b Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bEmployee", "requestBody": { "required": true, "content": { @@ -12590,7 +12950,7 @@ }, "responses": { "200": { - "description": "List of MeasurementDisplayUnit", + "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12604,7 +12964,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12622,7 +12982,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -12639,14 +12999,14 @@ } } }, - "/measurement-system": { + "/b2b-order-employee": { "get": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "List with basic information of Measurement System resources.", - "description": "Available since: 6.7.1.0", - "operationId": "getMeasurementSystemList", + "summary": "List with basic information of B2b Order Employee resources.", + "description": "", + "operationId": "getB2bOrderEmployeeList", "parameters": [ { "name": "limit", @@ -12675,7 +13035,7 @@ ], "responses": { "200": { - "description": "List of Measurement System resources.", + "description": "List of B2b Order Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12694,7 +13054,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } ] @@ -12708,16 +13068,16 @@ "type": "object", "properties": { "first": { - "example": "/measurement-system?limit=25" + "example": "/b2b-order-employee?limit=25" }, "last": { - "example": "/measurement-system?limit=25&page=11" + "example": "/b2b-order-employee?limit=25&page=11" }, "next": { - "example": "/measurement-system?limit=25&page=4" + "example": "/b2b-order-employee?limit=25&page=4" }, "prev": { - "example": "/measurement-system?limit=25&page=2" + "example": "/b2b-order-employee?limit=25&page=2" } } } @@ -12738,7 +13098,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12753,11 +13113,11 @@ }, "post": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "Create a new Measurement System resources.", - "description": "Available since: 6.7.1.0", - "operationId": "createMeasurementSystem", + "summary": "Create a new B2b Order Employee resources.", + "description": "", + "operationId": "createB2bOrderEmployee", "parameters": [ { "name": "_response", @@ -12776,14 +13136,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of MeasurementSystem", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12795,7 +13155,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12810,7 +13170,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12826,14 +13186,29 @@ } } }, - "/search/measurement-system": { + "/search/b2b-order-employee": { "post": { "tags": [ - "Measurement System" + "B2b Order Employee" + ], + "summary": "Search for the B2b Order Employee resources.", + "description": "", + "operationId": "searchB2bOrderEmployee", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Measurement System resources.", - "description": "Available since: 6.7.1.0", - "operationId": "searchMeasurementSystem", "requestBody": { "required": true, "content": { @@ -12846,7 +13221,7 @@ }, "responses": { "200": { - "description": "List of MeasurementSystem", + "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12860,7 +13235,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12878,7 +13253,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12895,19 +13270,19 @@ } } }, - "/measurement-system/{id}": { + "/b2b-order-employee/{id}": { "get": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "Detailed information about a Measurement System resource.", - "description": "Available since: 6.7.1.0", - "operationId": "getMeasurementSystem", + "summary": "Detailed information about a B2b Order Employee resource.", + "description": "", + "operationId": "getB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_system", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -12917,7 +13292,7 @@ ], "responses": { "200": { - "description": "Detail of MeasurementSystem", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12929,7 +13304,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12944,7 +13319,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -12961,16 +13336,16 @@ }, "delete": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "Delete a Measurement System resource.", - "description": "Available since: 6.7.1.0", - "operationId": "deleteMeasurementSystem", + "summary": "Delete a B2b Order Employee resource.", + "description": "", + "operationId": "deleteB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_system", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -13001,16 +13376,16 @@ }, "patch": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "Partially update information about a Measurement System resource.", - "description": "Available since: 6.7.1.0", - "operationId": "updateMeasurementSystem", + "summary": "Partially update information about a B2b Order Employee resource.", + "description": "", + "operationId": "updateB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the measurement_system", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -13028,18 +13403,18 @@ } ], "requestBody": { - "description": "Partially update information about a Measurement System resource.", + "description": "Partially update information about a B2b Order Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of MeasurementSystem", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13051,7 +13426,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13066,7 +13441,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13085,14 +13460,14 @@ } } }, - "/aggregate/measurement-system": { + "/aggregate/b2b-order-employee": { "post": { "tags": [ - "Measurement System" + "B2b Order Employee" ], - "summary": "Aggregate for the Measurement System resources.", - "description": "Available since: 6.7.1.0", - "operationId": "aggregateMeasurementSystem", + "summary": "Aggregate for the B2b Order Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bOrderEmployee", "requestBody": { "required": true, "content": { @@ -13116,7 +13491,7 @@ }, "responses": { "200": { - "description": "List of MeasurementSystem", + "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13130,7 +13505,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13148,7 +13523,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementSystem" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13165,14 +13540,14 @@ } } }, - "/media-ai-tag": { + "/b2b-permission": { "get": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "List with basic information of Media Ai Tag resources.", + "summary": "List with basic information of B2b Permission resources.", "description": "", - "operationId": "getMediaAiTagList", + "operationId": "getB2bPermissionList", "parameters": [ { "name": "limit", @@ -13201,7 +13576,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of B2b Permission resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13220,7 +13595,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } ] @@ -13234,16 +13609,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/b2b-permission?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/b2b-permission?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/b2b-permission?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/b2b-permission?limit=25&page=2" } } } @@ -13264,7 +13639,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13279,11 +13654,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Create a new Media Ai Tag resources.", + "summary": "Create a new B2b Permission resources.", "description": "", - "operationId": "createMediaAiTag", + "operationId": "createB2bPermission", "parameters": [ { "name": "_response", @@ -13302,14 +13677,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -13321,7 +13696,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13336,7 +13711,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13352,14 +13727,29 @@ } } }, - "/search/media-ai-tag": { + "/search/b2b-permission": { "post": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Search for the Media Ai Tag resources.", + "summary": "Search for the B2b Permission resources.", "description": "", - "operationId": "searchMediaAiTag", + "operationId": "searchB2bPermission", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -13372,7 +13762,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -13386,7 +13776,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13404,7 +13794,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13421,19 +13811,19 @@ } } }, - "/media-ai-tag/{id}": { + "/b2b-permission/{id}": { "get": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Detailed information about a Media Ai Tag resource.", + "summary": "Detailed information about a B2b Permission resource.", "description": "", - "operationId": "getMediaAiTag", + "operationId": "getB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -13443,7 +13833,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -13455,7 +13845,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13470,7 +13860,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13487,16 +13877,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Delete a Media Ai Tag resource.", + "summary": "Delete a B2b Permission resource.", "description": "", - "operationId": "deleteMediaAiTag", + "operationId": "deleteB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -13527,16 +13917,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Partially update information about a Media Ai Tag resource.", + "summary": "Partially update information about a B2b Permission resource.", "description": "", - "operationId": "updateMediaAiTag", + "operationId": "updateB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -13554,18 +13944,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a B2b Permission resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -13577,7 +13967,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13592,7 +13982,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13611,14 +14001,14 @@ } } }, - "/aggregate/media-ai-tag": { + "/aggregate/b2b-permission": { "post": { "tags": [ - "Media Ai Tag" + "B2b Permission" ], - "summary": "Aggregate for the Media Ai Tag resources.", + "summary": "Aggregate for the B2b Permission resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaAiTag", + "operationId": "aggregateB2bPermission", "requestBody": { "required": true, "content": { @@ -13642,7 +14032,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -13656,7 +14046,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13674,7 +14064,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -13691,14 +14081,14 @@ } } }, - "/order-product-warehouse": { + "/custom-price": { "get": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "List with basic information of Order Product Warehouse resources.", + "summary": "List with basic information of Custom Price resources.", "description": "", - "operationId": "getOrderProductWarehouseList", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -13727,7 +14117,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13746,7 +14136,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -13760,16 +14150,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -13790,7 +14180,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13805,11 +14195,11 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Create a new Order Product Warehouse resources.", + "summary": "Create a new Custom Price resources.", "description": "", - "operationId": "createOrderProductWarehouse", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -13828,14 +14218,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -13847,7 +14237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13862,7 +14252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13878,14 +14268,29 @@ } } }, - "/search/order-product-warehouse": { + "/search/custom-price": { "post": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Search for the Order Product Warehouse resources.", + "summary": "Search for the Custom Price resources.", "description": "", - "operationId": "searchOrderProductWarehouse", + "operationId": "searchCustomPrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -13898,7 +14303,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -13912,7 +14317,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13930,7 +14335,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13947,19 +14352,19 @@ } } }, - "/order-product-warehouse/{id}": { + "/custom-price/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Detailed information about a Order Product Warehouse resource.", + "summary": "Detailed information about a Custom Price resource.", "description": "", - "operationId": "getOrderProductWarehouse", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -13969,7 +14374,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -13981,7 +14386,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -13996,7 +14401,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -14013,16 +14418,16 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Delete a Order Product Warehouse resource.", + "summary": "Delete a Custom Price resource.", "description": "", - "operationId": "deleteOrderProductWarehouse", + "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -14053,16 +14458,16 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Partially update information about a Order Product Warehouse resource.", + "summary": "Partially update information about a Custom Price resource.", "description": "", - "operationId": "updateOrderProductWarehouse", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -14080,18 +14485,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a Custom Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14103,7 +14508,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -14118,7 +14523,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -14137,14 +14542,14 @@ } } }, - "/aggregate/order-product-warehouse": { + "/aggregate/custom-price": { "post": { "tags": [ - "Order Product Warehouse" + "Custom Price" ], - "summary": "Aggregate for the Order Product Warehouse resources.", + "summary": "Aggregate for the Custom Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderProductWarehouse", + "operationId": "aggregateCustomPrice", "requestBody": { "required": true, "content": { @@ -14168,7 +14573,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14182,7 +14587,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -14200,7 +14605,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -14217,14 +14622,14 @@ } } }, - "/order-return": { + "/customer-specific-features": { "get": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "List with basic information of Order Return resources.", + "summary": "List with basic information of Customer Specific Features resources.", "description": "", - "operationId": "getOrderReturnList", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -14253,7 +14658,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14272,7 +14677,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -14286,16 +14691,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -14316,7 +14721,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14331,11 +14736,11 @@ }, "post": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Create a new Order Return resources.", + "summary": "Create a new Customer Specific Features resources.", "description": "", - "operationId": "createOrderReturn", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -14354,14 +14759,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -14373,7 +14778,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14388,7 +14793,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14404,14 +14809,29 @@ } } }, - "/search/order-return": { + "/search/customer-specific-features": { "post": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Search for the Order Return resources.", + "summary": "Search for the Customer Specific Features resources.", "description": "", - "operationId": "searchOrderReturn", + "operationId": "searchCustomerSpecificFeatures", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -14424,7 +14844,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -14438,7 +14858,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14456,7 +14876,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14473,19 +14893,19 @@ } } }, - "/order-return/{id}": { + "/customer-specific-features/{id}": { "get": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Detailed information about a Order Return resource.", + "summary": "Detailed information about a Customer Specific Features resource.", "description": "", - "operationId": "getOrderReturn", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -14495,7 +14915,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -14507,7 +14927,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14522,7 +14942,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14539,16 +14959,16 @@ }, "delete": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Delete a Order Return resource.", + "summary": "Delete a Customer Specific Features resource.", "description": "", - "operationId": "deleteOrderReturn", + "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -14579,16 +14999,16 @@ }, "patch": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Partially update information about a Order Return resource.", + "summary": "Partially update information about a Customer Specific Features resource.", "description": "", - "operationId": "updateOrderReturn", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -14606,18 +15026,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -14629,7 +15049,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14644,7 +15064,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14663,14 +15083,14 @@ } } }, - "/aggregate/order-return": { + "/aggregate/customer-specific-features": { "post": { "tags": [ - "Order Return" + "Customer Specific Features" ], - "summary": "Aggregate for the Order Return resources.", + "summary": "Aggregate for the Customer Specific Features resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturn", + "operationId": "aggregateCustomerSpecificFeatures", "requestBody": { "required": true, "content": { @@ -14694,7 +15114,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -14708,7 +15128,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14726,7 +15146,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -14743,14 +15163,14 @@ } } }, - "/order-return-line-item": { + "/media-ai-tag": { "get": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "List with basic information of Order Return Line Item resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getOrderReturnLineItemList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -14779,7 +15199,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14798,7 +15218,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -14812,16 +15232,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -14842,7 +15262,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -14857,11 +15277,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Create a new Order Return Line Item resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createOrderReturnLineItem", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -14880,14 +15300,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -14899,7 +15319,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -14914,7 +15334,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -14930,14 +15350,29 @@ } } }, - "/search/order-return-line-item": { + "/search/media-ai-tag": { "post": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Search for the Order Return Line Item resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchOrderReturnLineItem", + "operationId": "searchMediaAiTag", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -14950,7 +15385,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -14964,7 +15399,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -14982,7 +15417,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -14999,19 +15434,19 @@ } } }, - "/order-return-line-item/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Detailed information about a Order Return Line Item resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getOrderReturnLineItem", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -15021,7 +15456,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -15033,7 +15468,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15048,7 +15483,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15065,16 +15500,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Delete a Order Return Line Item resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteOrderReturnLineItem", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -15105,16 +15540,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Partially update information about a Order Return Line Item resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateOrderReturnLineItem", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -15132,18 +15567,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -15155,7 +15590,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15170,7 +15605,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15189,14 +15624,14 @@ } } }, - "/aggregate/order-return-line-item": { + "/aggregate/media-ai-tag": { "post": { "tags": [ - "Order Return Line Item" + "Media Ai Tag" ], - "summary": "Aggregate for the Order Return Line Item resources.", + "summary": "Aggregate for the Media Ai Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItem", + "operationId": "aggregateMediaAiTag", "requestBody": { "required": true, "content": { @@ -15220,7 +15655,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -15234,7 +15669,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15252,7 +15687,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -15269,14 +15704,14 @@ } } }, - "/order-return-line-item-reason": { + "/order-product-warehouse": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", + "summary": "List with basic information of Order Product Warehouse resources.", "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", @@ -15305,7 +15740,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15324,7 +15759,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } ] @@ -15338,16 +15773,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/order-product-warehouse?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/order-product-warehouse?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/order-product-warehouse?limit=25&page=2" } } } @@ -15368,7 +15803,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15383,11 +15818,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Create a new Order Return Line Item Reason resources.", + "summary": "Create a new Order Product Warehouse resources.", "description": "", - "operationId": "createOrderReturnLineItemReason", + "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", @@ -15406,14 +15841,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -15425,7 +15860,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15440,7 +15875,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15456,14 +15891,29 @@ } } }, - "/search/order-return-line-item-reason": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Search for the Order Return Line Item Reason resources.", + "summary": "Search for the Order Product Warehouse resources.", "description": "", - "operationId": "searchOrderReturnLineItemReason", + "operationId": "searchOrderProductWarehouse", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -15476,7 +15926,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -15490,7 +15940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15508,7 +15958,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15525,19 +15975,19 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/order-product-warehouse/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", + "summary": "Detailed information about a Order Product Warehouse resource.", "description": "", - "operationId": "getOrderReturnLineItemReason", + "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -15547,7 +15997,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -15559,7 +16009,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15574,7 +16024,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15591,16 +16041,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Delete a Order Return Line Item Reason resource.", + "summary": "Delete a Order Product Warehouse resource.", "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -15631,16 +16081,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", + "summary": "Partially update information about a Order Product Warehouse resource.", "description": "", - "operationId": "updateOrderReturnLineItemReason", + "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -15658,18 +16108,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -15681,7 +16131,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15696,7 +16146,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15715,14 +16165,14 @@ } } }, - "/aggregate/order-return-line-item-reason": { + "/aggregate/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Product Warehouse" ], - "summary": "Aggregate for the Order Return Line Item Reason resources.", + "summary": "Aggregate for the Order Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItemReason", + "operationId": "aggregateOrderProductWarehouse", "requestBody": { "required": true, "content": { @@ -15746,7 +16196,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -15760,7 +16210,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15778,7 +16228,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -15795,14 +16245,14 @@ } } }, - "/order-warehouse-group": { + "/order-return": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of Order Return resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", @@ -15831,7 +16281,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15850,7 +16300,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } ] @@ -15864,16 +16314,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/order-return?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/order-return?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/order-return?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/order-return?limit=25&page=2" } } } @@ -15894,7 +16344,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -15909,11 +16359,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new Order Return resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createOrderReturn", "parameters": [ { "name": "_response", @@ -15932,14 +16382,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -15951,7 +16401,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -15966,7 +16416,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -15982,14 +16432,29 @@ } } }, - "/search/order-warehouse-group": { + "/search/order-return": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Search for the Order Warehouse Group resources.", + "summary": "Search for the Order Return resources.", "description": "", - "operationId": "searchOrderWarehouseGroup", + "operationId": "searchOrderReturn", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -16002,7 +16467,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -16016,7 +16481,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16034,7 +16499,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16051,19 +16516,19 @@ } } }, - "/order-warehouse-group/{id}": { + "/order-return/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a Order Return resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -16073,7 +16538,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -16085,7 +16550,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16100,7 +16565,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16117,16 +16582,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a Order Return resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -16157,16 +16622,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a Order Return resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -16184,18 +16649,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a Order Return resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -16207,7 +16672,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16222,7 +16687,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16241,14 +16706,14 @@ } } }, - "/aggregate/order-warehouse-group": { + "/aggregate/order-return": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return" ], - "summary": "Aggregate for the Order Warehouse Group resources.", + "summary": "Aggregate for the Order Return resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderWarehouseGroup", + "operationId": "aggregateOrderReturn", "requestBody": { "required": true, "content": { @@ -16272,7 +16737,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -16286,7 +16751,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16304,7 +16769,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -16321,14 +16786,14 @@ } } }, - "/product-review-summary": { + "/order-return-line-item": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "List with basic information of Product Review Summary resources.", + "summary": "List with basic information of Order Return Line Item resources.", "description": "", - "operationId": "getProductReviewSummaryList", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -16357,7 +16822,7 @@ ], "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16376,7 +16841,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -16390,16 +16855,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review-summary?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/product-review-summary?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/product-review-summary?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/product-review-summary?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -16420,7 +16885,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16435,11 +16900,11 @@ }, "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Create a new Product Review Summary resources.", + "summary": "Create a new Order Return Line Item resources.", "description": "", - "operationId": "createProductReviewSummary", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -16458,14 +16923,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -16477,7 +16942,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16492,7 +16957,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16508,14 +16973,29 @@ } } }, - "/search/product-review-summary": { + "/search/order-return-line-item": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Search for the Product Review Summary resources.", + "summary": "Search for the Order Return Line Item resources.", "description": "", - "operationId": "searchProductReviewSummary", + "operationId": "searchOrderReturnLineItem", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -16528,7 +17008,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -16542,7 +17022,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16560,7 +17040,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16577,19 +17057,19 @@ } } }, - "/product-review-summary/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Detailed information about a Product Review Summary resource.", + "summary": "Detailed information about a Order Return Line Item resource.", "description": "", - "operationId": "getProductReviewSummary", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -16599,7 +17079,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -16611,7 +17091,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16626,7 +17106,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16643,16 +17123,16 @@ }, "delete": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Delete a Product Review Summary resource.", + "summary": "Delete a Order Return Line Item resource.", "description": "", - "operationId": "deleteProductReviewSummary", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -16683,16 +17163,16 @@ }, "patch": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Partially update information about a Product Review Summary resource.", + "summary": "Partially update information about a Order Return Line Item resource.", "description": "", - "operationId": "updateProductReviewSummary", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -16710,18 +17190,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -16733,7 +17213,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16748,7 +17228,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16767,14 +17247,14 @@ } } }, - "/aggregate/product-review-summary": { + "/aggregate/order-return-line-item": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item" ], - "summary": "Aggregate for the Product Review Summary resources.", + "summary": "Aggregate for the Order Return Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReviewSummary", + "operationId": "aggregateOrderReturnLineItem", "requestBody": { "required": true, "content": { @@ -16798,7 +17278,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -16812,7 +17292,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16830,7 +17310,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -16847,14 +17327,14 @@ } } }, - "/product-warehouse": { + "/order-return-line-item-reason": { "get": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "List with basic information of Product Warehouse resources.", + "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", - "operationId": "getProductWarehouseList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -16883,7 +17363,7 @@ ], "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16902,7 +17382,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -16916,16 +17396,16 @@ "type": "object", "properties": { "first": { - "example": "/product-warehouse?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/product-warehouse?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/product-warehouse?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/product-warehouse?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -16946,7 +17426,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -16961,11 +17441,11 @@ }, "post": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Create a new Product Warehouse resources.", + "summary": "Create a new Order Return Line Item Reason resources.", "description": "", - "operationId": "createProductWarehouse", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -16984,14 +17464,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -17003,7 +17483,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17018,7 +17498,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17034,14 +17514,29 @@ } } }, - "/search/product-warehouse": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Search for the Product Warehouse resources.", + "summary": "Search for the Order Return Line Item Reason resources.", "description": "", - "operationId": "searchProductWarehouse", + "operationId": "searchOrderReturnLineItemReason", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -17054,7 +17549,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -17068,7 +17563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17086,7 +17581,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17103,19 +17598,19 @@ } } }, - "/product-warehouse/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Detailed information about a Product Warehouse resource.", + "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "getProductWarehouse", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -17125,7 +17620,7 @@ ], "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -17137,7 +17632,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17152,7 +17647,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17169,16 +17664,16 @@ }, "delete": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Delete a Product Warehouse resource.", + "summary": "Delete a Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteProductWarehouse", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -17209,16 +17704,16 @@ }, "patch": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Partially update information about a Product Warehouse resource.", + "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "updateProductWarehouse", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -17236,18 +17731,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -17259,7 +17754,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17274,7 +17769,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17293,14 +17788,14 @@ } } }, - "/aggregate/product-warehouse": { + "/aggregate/order-return-line-item-reason": { "post": { "tags": [ - "Product Warehouse" + "Order Return Line Item Reason" ], - "summary": "Aggregate for the Product Warehouse resources.", + "summary": "Aggregate for the Order Return Line Item Reason resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductWarehouse", + "operationId": "aggregateOrderReturnLineItemReason", "requestBody": { "required": true, "content": { @@ -17324,7 +17819,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -17338,7 +17833,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17356,7 +17851,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -17373,14 +17868,14 @@ } } }, - "/quote": { + "/order-warehouse-group": { "get": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of Order Warehouse Group resources.", + "description": "", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -17409,7 +17904,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17428,7 +17923,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -17442,16 +17937,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -17472,7 +17967,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17487,11 +17982,11 @@ }, "post": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new Order Warehouse Group resources.", + "description": "", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -17510,14 +18005,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -17529,7 +18024,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17544,7 +18039,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17560,14 +18055,29 @@ } } }, - "/search/quote": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Quote" + "Order Warehouse Group" + ], + "summary": "Search for the Order Warehouse Group resources.", + "description": "", + "operationId": "searchOrderWarehouseGroup", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", "requestBody": { "required": true, "content": { @@ -17580,7 +18090,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -17594,7 +18104,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17612,7 +18122,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17629,19 +18139,19 @@ } } }, - "/quote/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a Order Warehouse Group resource.", + "description": "", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -17651,7 +18161,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -17663,7 +18173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17678,7 +18188,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17695,16 +18205,16 @@ }, "delete": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a Order Warehouse Group resource.", + "description": "", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -17735,16 +18245,16 @@ }, "patch": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a Order Warehouse Group resource.", + "description": "", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -17762,18 +18272,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -17785,7 +18295,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17800,7 +18310,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17819,14 +18329,14 @@ } } }, - "/aggregate/quote": { + "/aggregate/order-warehouse-group": { "post": { "tags": [ - "Quote" + "Order Warehouse Group" ], - "summary": "Aggregate for the Quote resources.", + "summary": "Aggregate for the Order Warehouse Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuote", + "operationId": "aggregateOrderWarehouseGroup", "requestBody": { "required": true, "content": { @@ -17850,7 +18360,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -17864,7 +18374,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17882,7 +18392,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -17899,14 +18409,14 @@ } } }, - "/quote-comment": { + "/product-review-summary": { "get": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "List with basic information of Quote Comment resources.", + "summary": "List with basic information of Product Review Summary resources.", "description": "", - "operationId": "getQuoteCommentList", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -17935,7 +18445,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17954,7 +18464,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -17968,16 +18478,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -17998,7 +18508,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18013,11 +18523,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Create a new Quote Comment resources.", + "summary": "Create a new Product Review Summary resources.", "description": "", - "operationId": "createQuoteComment", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -18036,14 +18546,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -18055,7 +18565,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18070,7 +18580,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18086,14 +18596,29 @@ } } }, - "/search/quote-comment": { + "/search/product-review-summary": { "post": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Search for the Quote Comment resources.", + "summary": "Search for the Product Review Summary resources.", "description": "", - "operationId": "searchQuoteComment", + "operationId": "searchProductReviewSummary", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -18106,7 +18631,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -18120,7 +18645,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18138,7 +18663,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18155,19 +18680,19 @@ } } }, - "/quote-comment/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Detailed information about a Quote Comment resource.", + "summary": "Detailed information about a Product Review Summary resource.", "description": "", - "operationId": "getQuoteComment", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -18177,7 +18702,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -18189,7 +18714,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18204,7 +18729,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18221,16 +18746,16 @@ }, "delete": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Delete a Quote Comment resource.", + "summary": "Delete a Product Review Summary resource.", "description": "", - "operationId": "deleteQuoteComment", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -18261,16 +18786,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Partially update information about a Quote Comment resource.", + "summary": "Partially update information about a Product Review Summary resource.", "description": "", - "operationId": "updateQuoteComment", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -18288,18 +18813,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -18311,7 +18836,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18326,7 +18851,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18345,14 +18870,14 @@ } } }, - "/aggregate/quote-comment": { + "/aggregate/product-review-summary": { "post": { "tags": [ - "Quote Comment" + "Product Review Summary" ], - "summary": "Aggregate for the Quote Comment resources.", + "summary": "Aggregate for the Product Review Summary resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteComment", + "operationId": "aggregateProductReviewSummary", "requestBody": { "required": true, "content": { @@ -18376,7 +18901,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -18390,7 +18915,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18408,7 +18933,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -18425,14 +18950,14 @@ } } }, - "/quote-delivery": { + "/product-warehouse": { "get": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "List with basic information of Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "summary": "List with basic information of Product Warehouse resources.", + "description": "", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -18461,7 +18986,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18480,7 +19005,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -18494,16 +19019,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -18524,7 +19049,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18539,11 +19064,11 @@ }, "post": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "Create a new Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "summary": "Create a new Product Warehouse resources.", + "description": "", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -18562,14 +19087,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -18581,7 +19106,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18596,7 +19121,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18612,14 +19137,29 @@ } } }, - "/search/quote-delivery": { + "/search/product-warehouse": { "post": { "tags": [ - "Quote Delivery" + "Product Warehouse" + ], + "summary": "Search for the Product Warehouse resources.", + "description": "", + "operationId": "searchProductWarehouse", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", "requestBody": { "required": true, "content": { @@ -18632,7 +19172,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -18646,7 +19186,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18664,7 +19204,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18681,19 +19221,19 @@ } } }, - "/quote-delivery/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "Detailed information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "summary": "Detailed information about a Product Warehouse resource.", + "description": "", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -18703,7 +19243,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -18715,7 +19255,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18730,7 +19270,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18747,16 +19287,16 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "Delete a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "summary": "Delete a Product Warehouse resource.", + "description": "", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -18787,16 +19327,16 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "Partially update information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "summary": "Partially update information about a Product Warehouse resource.", + "description": "", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -18814,18 +19354,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -18837,7 +19377,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18852,7 +19392,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18871,14 +19411,14 @@ } } }, - "/aggregate/quote-delivery": { + "/aggregate/product-warehouse": { "post": { "tags": [ - "Quote Delivery" + "Product Warehouse" ], - "summary": "Aggregate for the Quote Delivery resources.", + "summary": "Aggregate for the Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDelivery", + "operationId": "aggregateProductWarehouse", "requestBody": { "required": true, "content": { @@ -18902,7 +19442,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -18916,7 +19456,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18934,7 +19474,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -18951,14 +19491,14 @@ } } }, - "/quote-delivery-position": { + "/quote": { "get": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "List with basic information of Quote Delivery Position resources.", + "summary": "List with basic information of Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -18987,7 +19527,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19006,7 +19546,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } ] @@ -19020,16 +19560,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -19050,7 +19590,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19065,11 +19605,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Create a new Quote Delivery Position resources.", + "summary": "Create a new Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -19088,14 +19628,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -19107,7 +19647,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19122,7 +19662,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19138,14 +19678,29 @@ } } }, - "/search/quote-delivery-position": { + "/search/quote": { "post": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Search for the Quote Delivery Position resources.", + "summary": "Search for the Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", + "operationId": "searchQuote", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -19158,7 +19713,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -19172,7 +19727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19190,7 +19745,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19207,19 +19762,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Detailed information about a Quote Delivery Position resource.", + "summary": "Detailed information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -19229,7 +19784,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -19241,7 +19796,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19256,7 +19811,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19273,16 +19828,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Delete a Quote Delivery Position resource.", + "summary": "Delete a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -19313,16 +19868,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Partially update information about a Quote Delivery Position resource.", + "summary": "Partially update information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -19340,18 +19895,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Quote resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -19363,7 +19918,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19378,7 +19933,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19397,14 +19952,14 @@ } } }, - "/aggregate/quote-delivery-position": { + "/aggregate/quote": { "post": { "tags": [ - "Quote Delivery Position" + "Quote" ], - "summary": "Aggregate for the Quote Delivery Position resources.", + "summary": "Aggregate for the Quote resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDeliveryPosition", + "operationId": "aggregateQuote", "requestBody": { "required": true, "content": { @@ -19428,7 +19983,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -19442,7 +19997,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19460,7 +20015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/Quote" } } } @@ -19477,14 +20032,14 @@ } } }, - "/quote-document": { + "/quote-comment": { "get": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "List with basic information of Quote Document resources.", + "summary": "List with basic information of Quote Comment resources.", "description": "", - "operationId": "getQuoteDocumentList", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -19513,7 +20068,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19532,7 +20087,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -19546,16 +20101,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -19576,7 +20131,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19591,11 +20146,11 @@ }, "post": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Create a new Quote Document resources.", + "summary": "Create a new Quote Comment resources.", "description": "", - "operationId": "createQuoteDocument", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -19614,14 +20169,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -19633,7 +20188,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19648,7 +20203,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19664,14 +20219,29 @@ } } }, - "/search/quote-document": { + "/search/quote-comment": { "post": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Search for the Quote Document resources.", + "summary": "Search for the Quote Comment resources.", "description": "", - "operationId": "searchQuoteDocument", + "operationId": "searchQuoteComment", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -19684,7 +20254,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -19698,7 +20268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19716,7 +20286,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19733,19 +20303,19 @@ } } }, - "/quote-document/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Detailed information about a Quote Document resource.", + "summary": "Detailed information about a Quote Comment resource.", "description": "", - "operationId": "getQuoteDocument", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -19755,7 +20325,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -19767,7 +20337,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19782,7 +20352,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19799,16 +20369,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Delete a Quote Document resource.", + "summary": "Delete a Quote Comment resource.", "description": "", - "operationId": "deleteQuoteDocument", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -19839,16 +20409,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Partially update information about a Quote Document resource.", + "summary": "Partially update information about a Quote Comment resource.", "description": "", - "operationId": "updateQuoteDocument", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -19866,18 +20436,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -19889,7 +20459,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19904,7 +20474,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19923,14 +20493,14 @@ } } }, - "/aggregate/quote-document": { + "/aggregate/quote-comment": { "post": { "tags": [ - "Quote Document" + "Quote Comment" ], - "summary": "Aggregate for the Quote Document resources.", + "summary": "Aggregate for the Quote Comment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDocument", + "operationId": "aggregateQuoteComment", "requestBody": { "required": true, "content": { @@ -19954,7 +20524,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -19968,7 +20538,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -19986,7 +20556,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -20003,14 +20573,14 @@ } } }, - "/quote-employee": { + "/quote-delivery": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "List with basic information of Quote Employee resources.", - "description": "", - "operationId": "getQuoteEmployeeList", + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -20039,7 +20609,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20058,7 +20628,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -20072,16 +20642,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -20102,7 +20672,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20117,11 +20687,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "Create a new Quote Employee resources.", - "description": "", - "operationId": "createQuoteEmployee", + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -20140,14 +20710,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -20159,7 +20729,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20174,7 +20744,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20190,14 +20760,29 @@ } } }, - "/search/quote-employee": { + "/search/quote-delivery": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery" + ], + "summary": "Search for the Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDelivery", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Quote Employee resources.", - "description": "", - "operationId": "searchQuoteEmployee", "requestBody": { "required": true, "content": { @@ -20210,7 +20795,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -20224,7 +20809,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20242,7 +20827,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20259,19 +20844,19 @@ } } }, - "/quote-employee/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "Detailed information about a Quote Employee resource.", - "description": "", - "operationId": "getQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -20281,7 +20866,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -20293,7 +20878,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20308,7 +20893,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20325,16 +20910,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "Delete a Quote Employee resource.", - "description": "", - "operationId": "deleteQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -20365,16 +20950,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "Partially update information about a Quote Employee resource.", - "description": "", - "operationId": "updateQuoteEmployee", + "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_employee", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -20392,18 +20977,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -20415,7 +21000,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20430,7 +21015,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20449,14 +21034,14 @@ } } }, - "/aggregate/quote-employee": { + "/aggregate/quote-delivery": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery" ], - "summary": "Aggregate for the Quote Employee resources.", + "summary": "Aggregate for the Quote Delivery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteEmployee", + "operationId": "aggregateQuoteDelivery", "requestBody": { "required": true, "content": { @@ -20480,7 +21065,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -20494,7 +21079,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20512,7 +21097,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -20529,14 +21114,14 @@ } } }, - "/quote-line-item": { + "/quote-delivery-position": { "get": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "List with basic information of Quote Line Item resources.", + "summary": "List with basic information of Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", + "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", @@ -20565,7 +21150,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20584,7 +21169,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] @@ -20598,16 +21183,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/quote-delivery-position?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/quote-delivery-position?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/quote-delivery-position?limit=25&page=2" } } } @@ -20628,7 +21213,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20643,11 +21228,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Create a new Quote Line Item resources.", + "summary": "Create a new Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", @@ -20666,14 +21251,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -20685,7 +21270,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20700,7 +21285,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20716,14 +21301,29 @@ } } }, - "/search/quote-line-item": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Search for the Quote Line Item resources.", + "summary": "Search for the Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", + "operationId": "searchQuoteDeliveryPosition", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -20736,7 +21336,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -20750,7 +21350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20768,7 +21368,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20785,19 +21385,19 @@ } } }, - "/quote-line-item/{id}": { + "/quote-delivery-position/{id}": { "get": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Detailed information about a Quote Line Item resource.", + "summary": "Detailed information about a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "operationId": "getQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -20807,7 +21407,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -20819,7 +21419,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20834,7 +21434,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20851,16 +21451,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Delete a Quote Line Item resource.", + "summary": "Delete a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "operationId": "deleteQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -20891,16 +21491,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Partially update information about a Quote Line Item resource.", + "summary": "Partially update information about a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", + "operationId": "updateQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -20918,18 +21518,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -20941,7 +21541,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20956,7 +21556,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -20975,14 +21575,14 @@ } } }, - "/aggregate/quote-line-item": { + "/aggregate/quote-delivery-position": { "post": { "tags": [ - "Quote Line Item" + "Quote Delivery Position" ], - "summary": "Aggregate for the Quote Line Item resources.", + "summary": "Aggregate for the Quote Delivery Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteLineItem", + "operationId": "aggregateQuoteDeliveryPosition", "requestBody": { "required": true, "content": { @@ -21006,7 +21606,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -21020,7 +21620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -21038,7 +21638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -21055,14 +21655,14 @@ } } }, - "/quote-transaction": { + "/quote-document": { "get": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "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 Document resources.", + "description": "", + "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", @@ -21091,7 +21691,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21110,7 +21710,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } ] @@ -21124,16 +21724,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/quote-document?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/quote-document?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/quote-document?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/quote-document?limit=25&page=2" } } } @@ -21154,7 +21754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21169,11 +21769,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "summary": "Create a new Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "summary": "Create a new Quote Document resources.", + "description": "", + "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", @@ -21192,14 +21792,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -21211,7 +21811,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21226,7 +21826,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21242,14 +21842,29 @@ } } }, - "/search/quote-transaction": { + "/search/quote-document": { "post": { "tags": [ - "Quote Transaction" + "Quote Document" + ], + "summary": "Search for the Quote Document resources.", + "description": "", + "operationId": "searchQuoteDocument", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", "requestBody": { "required": true, "content": { @@ -21262,7 +21877,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -21276,7 +21891,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21294,7 +21909,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21311,19 +21926,19 @@ } } }, - "/quote-transaction/{id}": { + "/quote-document/{id}": { "get": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "summary": "Detailed information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "summary": "Detailed information about a Quote Document resource.", + "description": "", + "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -21333,7 +21948,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -21345,7 +21960,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21360,7 +21975,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21377,16 +21992,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "summary": "Delete a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "summary": "Delete a Quote Document resource.", + "description": "", + "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -21417,16 +22032,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "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 Document resource.", + "description": "", + "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -21444,18 +22059,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Quote Document resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -21467,7 +22082,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21482,7 +22097,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21501,14 +22116,14 @@ } } }, - "/aggregate/quote-transaction": { + "/aggregate/quote-document": { "post": { "tags": [ - "Quote Transaction" + "Quote Document" ], - "summary": "Aggregate for the Quote Transaction resources.", + "summary": "Aggregate for the Quote Document resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteTransaction", + "operationId": "aggregateQuoteDocument", "requestBody": { "required": true, "content": { @@ -21532,7 +22147,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -21546,7 +22161,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21564,7 +22179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -21581,15 +22196,14 @@ } } }, - "/spatial-render-config-size": { + "/quote-employee": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Quote Employee resources.", "description": "", - "operationId": "getSpatialRenderConfigSizeList", + "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", @@ -21618,7 +22232,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21637,7 +22251,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } ] @@ -21651,16 +22265,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/quote-employee?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/quote-employee?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/quote-employee?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/quote-employee?limit=25&page=2" } } } @@ -21681,7 +22295,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21696,12 +22310,11 @@ }, "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Quote Employee resources.", "description": "", - "operationId": "createSpatialRenderConfigSize", + "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", @@ -21720,14 +22333,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -21739,7 +22352,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21754,7 +22367,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21770,15 +22383,29 @@ } } }, - "/search/spatial-render-config-size": { + "/search/quote-employee": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Quote Employee resources.", "description": "", - "operationId": "searchSpatialRenderConfigSize", + "operationId": "searchQuoteEmployee", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -21791,7 +22418,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -21805,7 +22432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21823,7 +22450,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21840,20 +22467,19 @@ } } }, - "/spatial-render-config-size/{id}": { + "/quote-employee/{id}": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Quote Employee resource.", "description": "", - "operationId": "getSpatialRenderConfigSize", + "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -21863,7 +22489,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -21875,7 +22501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21890,7 +22516,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -21907,17 +22533,16 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Quote Employee resource.", "description": "", - "operationId": "deleteSpatialRenderConfigSize", + "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -21948,17 +22573,16 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Quote Employee resource.", "description": "", - "operationId": "updateSpatialRenderConfigSize", + "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -21976,18 +22600,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Quote Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -21999,7 +22623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -22014,7 +22638,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -22033,15 +22657,14 @@ } } }, - "/aggregate/spatial-render-config-size": { + "/aggregate/quote-employee": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Employee" ], - "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 Employee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialRenderConfigSize", + "operationId": "aggregateQuoteEmployee", "requestBody": { "required": true, "content": { @@ -22065,7 +22688,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -22079,7 +22702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -22097,7 +22720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -22114,15 +22737,14 @@ } } }, - "/spatial-scene": { + "/quote-line-item": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", @@ -22151,7 +22773,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22170,7 +22792,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -22184,16 +22806,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/quote-line-item?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/quote-line-item?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/quote-line-item?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/quote-line-item?limit=25&page=2" } } } @@ -22214,7 +22836,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22229,12 +22851,11 @@ }, "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", @@ -22253,14 +22874,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22272,7 +22893,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22287,7 +22908,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22303,15 +22924,29 @@ } } }, - "/search/spatial-scene": { + "/search/quote-line-item": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" + ], + "summary": "Search for the Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteLineItem", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "searchSpatialScene", "requestBody": { "required": true, "content": { @@ -22324,7 +22959,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22338,7 +22973,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22356,7 +22991,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22373,20 +23008,19 @@ } } }, - "/spatial-scene/{id}": { + "/quote-line-item/{id}": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -22396,7 +23030,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22408,7 +23042,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22423,7 +23057,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22440,17 +23074,16 @@ }, "delete": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -22481,17 +23114,16 @@ }, "patch": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -22509,18 +23141,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22532,7 +23164,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22547,7 +23179,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22566,15 +23198,14 @@ } } }, - "/aggregate/spatial-scene": { + "/aggregate/quote-line-item": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Line Item" ], - "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 Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialScene", + "operationId": "aggregateQuoteLineItem", "requestBody": { "required": true, "content": { @@ -22598,7 +23229,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22612,7 +23243,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22630,7 +23261,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -22647,15 +23278,14 @@ } } }, - "/spatial-scene-camera": { + "/quote-transaction": { "get": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", @@ -22684,7 +23314,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22703,7 +23333,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -22717,16 +23347,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/quote-transaction?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/quote-transaction?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/quote-transaction?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/quote-transaction?limit=25&page=2" } } } @@ -22747,7 +23377,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22762,12 +23392,11 @@ }, "post": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", @@ -22786,14 +23415,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -22805,7 +23434,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22820,7 +23449,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22836,15 +23465,29 @@ } } }, - "/search/spatial-scene-camera": { + "/search/quote-transaction": { "post": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" + ], + "summary": "Search for the Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Search for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "searchSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -22857,7 +23500,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -22871,7 +23514,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22889,7 +23532,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22906,20 +23549,19 @@ } } }, - "/spatial-scene-camera/{id}": { + "/quote-transaction/{id}": { "get": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -22929,7 +23571,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -22941,7 +23583,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22956,7 +23598,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -22973,17 +23615,16 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -23014,17 +23655,16 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -23042,18 +23682,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -23065,7 +23705,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -23080,7 +23720,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -23099,15 +23739,14 @@ } } }, - "/aggregate/spatial-scene-camera": { + "/aggregate/quote-transaction": { "post": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Quote Transaction" ], - "summary": "Aggregate for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Quote Transaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneCamera", + "operationId": "aggregateQuoteTransaction", "requestBody": { "required": true, "content": { @@ -23131,7 +23770,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -23145,7 +23784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -23163,7 +23802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -23180,15 +23819,15 @@ } } }, - "/spatial-scene-group": { + "/spatial-render-config-size": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "List with basic information of Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial 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": "getSpatialSceneGroupList", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -23217,7 +23856,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Group resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23236,7 +23875,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -23250,16 +23889,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-group?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/spatial-scene-group?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/spatial-scene-group?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-group?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -23280,7 +23919,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23295,12 +23934,12 @@ }, "post": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Create a new Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial 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": "createSpatialSceneGroup", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -23319,14 +23958,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -23338,7 +23977,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23353,7 +23992,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23369,15 +24008,30 @@ } } }, - "/search/spatial-scene-group": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Search for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial 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": "searchSpatialSceneGroup", + "operationId": "searchSpatialRenderConfigSize", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -23390,7 +24044,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -23404,7 +24058,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23422,7 +24076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23439,20 +24093,20 @@ } } }, - "/spatial-scene-group/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial 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": "getSpatialSceneGroup", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -23462,7 +24116,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -23474,7 +24128,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23489,7 +24143,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23506,17 +24160,17 @@ }, "delete": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Delete a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial 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": "deleteSpatialSceneGroup", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -23547,17 +24201,17 @@ }, "patch": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial 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": "updateSpatialSceneGroup", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -23575,18 +24229,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Group resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -23598,7 +24252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23613,7 +24267,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23632,15 +24286,15 @@ } } }, - "/aggregate/spatial-scene-group": { + "/aggregate/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Render Config Size", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial 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": "aggregateSpatialSceneGroup", + "operationId": "aggregateSpatialRenderConfigSize", "requestBody": { "required": true, "content": { @@ -23664,7 +24318,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -23678,7 +24332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23696,7 +24350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -23713,15 +24367,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-scene": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "List with basic information of Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -23750,7 +24404,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23769,7 +24423,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -23783,16 +24437,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -23813,7 +24467,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -23828,12 +24482,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Create a new Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -23852,14 +24506,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -23871,7 +24525,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -23886,7 +24540,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -23902,15 +24556,30 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-scene": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Search for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchSpatialScene", + "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": { @@ -23923,7 +24592,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -23937,7 +24606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -23955,7 +24624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -23972,20 +24641,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -23995,7 +24664,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -24007,7 +24676,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24022,7 +24691,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24039,17 +24708,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Delete a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -24080,17 +24749,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -24108,18 +24777,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -24131,7 +24800,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24146,7 +24815,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24165,15 +24834,15 @@ } } }, - "/aggregate/spatial-scene-light": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene 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": "aggregateSpatialScene", "requestBody": { "required": true, "content": { @@ -24197,7 +24866,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -24211,7 +24880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24229,7 +24898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24246,15 +24915,15 @@ } } }, - "/spatial-scene-material": { + "/spatial-scene-camera": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterialList", + "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", @@ -24283,7 +24952,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Material resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24302,7 +24971,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -24316,16 +24985,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-material?limit=25" + "example": "/spatial-scene-camera?limit=25" }, "last": { - "example": "/spatial-scene-material?limit=25&page=11" + "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { - "example": "/spatial-scene-material?limit=25&page=4" + "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-material?limit=25&page=2" + "example": "/spatial-scene-camera?limit=25&page=2" } } } @@ -24346,7 +25015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24361,12 +25030,12 @@ }, "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneMaterial", + "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", @@ -24385,14 +25054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -24404,7 +25073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24419,7 +25088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24435,15 +25104,30 @@ } } }, - "/search/spatial-scene-material": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneMaterial", + "operationId": "searchSpatialSceneCamera", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -24456,7 +25140,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -24470,7 +25154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24488,7 +25172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24505,20 +25189,20 @@ } } }, - "/spatial-scene-material/{id}": { + "/spatial-scene-camera/{id}": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterial", + "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -24528,7 +25212,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -24540,7 +25224,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24555,7 +25239,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24572,17 +25256,17 @@ }, "delete": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneMaterial", + "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -24613,17 +25297,17 @@ }, "patch": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneMaterial", + "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -24641,18 +25325,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Material resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -24664,7 +25348,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24679,7 +25363,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24698,15 +25382,15 @@ } } }, - "/aggregate/spatial-scene-material": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Camera", "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 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": "aggregateSpatialSceneMaterial", + "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -24730,7 +25414,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -24744,7 +25428,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24762,7 +25446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -24779,15 +25463,15 @@ } } }, - "/spatial-scene-object": { + "/spatial-scene-group": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObjectList", + "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", @@ -24816,7 +25500,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24835,7 +25519,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } ] @@ -24849,16 +25533,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/spatial-scene-group?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/spatial-scene-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/spatial-scene-group?limit=25&page=2" } } } @@ -24879,7 +25563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -24894,12 +25578,12 @@ }, "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneObject", + "operationId": "createSpatialSceneGroup", "parameters": [ { "name": "_response", @@ -24918,14 +25602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -24937,7 +25621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -24952,7 +25636,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -24968,15 +25652,30 @@ } } }, - "/search/spatial-scene-object": { + "/search/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneObject", + "operationId": "searchSpatialSceneGroup", + "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": { @@ -24989,7 +25688,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -25003,7 +25702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25021,7 +25720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25038,20 +25737,20 @@ } } }, - "/spatial-scene-object/{id}": { + "/spatial-scene-group/{id}": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObject", + "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -25061,7 +25760,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -25073,7 +25772,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25088,7 +25787,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25105,17 +25804,17 @@ }, "delete": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneObject", + "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -25146,17 +25845,17 @@ }, "patch": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneObject", + "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -25174,18 +25873,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Spatial Scene Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -25197,7 +25896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25212,7 +25911,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25231,15 +25930,15 @@ } } }, - "/aggregate/spatial-scene-object": { + "/aggregate/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Group", "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 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": "aggregateSpatialSceneObject", + "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { @@ -25263,7 +25962,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -25277,7 +25976,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25295,7 +25994,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -25312,15 +26011,15 @@ } } }, - "/spatial-scene-primitive": { + "/spatial-scene-light": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitiveList", + "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", @@ -25349,7 +26048,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Primitive resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25368,7 +26067,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -25382,16 +26081,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-primitive?limit=25" + "example": "/spatial-scene-light?limit=25" }, "last": { - "example": "/spatial-scene-primitive?limit=25&page=11" + "example": "/spatial-scene-light?limit=25&page=11" }, "next": { - "example": "/spatial-scene-primitive?limit=25&page=4" + "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-primitive?limit=25&page=2" + "example": "/spatial-scene-light?limit=25&page=2" } } } @@ -25412,7 +26111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25427,12 +26126,12 @@ }, "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScenePrimitive", + "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", @@ -25451,14 +26150,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -25470,7 +26169,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25485,7 +26184,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25501,15 +26200,30 @@ } } }, - "/search/spatial-scene-primitive": { + "/search/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScenePrimitive", + "operationId": "searchSpatialSceneLight", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -25522,7 +26236,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -25536,7 +26250,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25554,7 +26268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25571,20 +26285,20 @@ } } }, - "/spatial-scene-primitive/{id}": { + "/spatial-scene-light/{id}": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitive", + "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -25594,7 +26308,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -25606,7 +26320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25621,7 +26335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25638,17 +26352,17 @@ }, "delete": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScenePrimitive", + "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -25679,17 +26393,17 @@ }, "patch": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScenePrimitive", + "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -25707,18 +26421,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Primitive resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -25730,7 +26444,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25745,7 +26459,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25764,15 +26478,15 @@ } } }, - "/aggregate/spatial-scene-primitive": { + "/aggregate/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Light", "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 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": "aggregateSpatialScenePrimitive", + "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -25796,7 +26510,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -25810,7 +26524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25828,7 +26542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -25845,15 +26559,15 @@ } } }, - "/sso-provider": { + "/spatial-scene-material": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderList", + "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", @@ -25882,7 +26596,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25901,7 +26615,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] @@ -25915,16 +26629,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/spatial-scene-material?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/spatial-scene-material?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/spatial-scene-material?limit=25&page=2" } } } @@ -25945,7 +26659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -25960,12 +26674,12 @@ }, "post": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSsoProvider", + "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", @@ -25984,14 +26698,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -26003,7 +26717,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26018,7 +26732,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26034,15 +26748,30 @@ } } }, - "/search/sso-provider": { + "/search/spatial-scene-material": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSsoProvider", + "operationId": "searchSpatialSceneMaterial", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -26055,7 +26784,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -26069,7 +26798,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26087,7 +26816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26104,20 +26833,20 @@ } } }, - "/sso-provider/{id}": { + "/spatial-scene-material/{id}": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProvider", + "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -26127,7 +26856,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -26139,7 +26868,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26154,7 +26883,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26171,17 +26900,17 @@ }, "delete": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSsoProvider", + "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -26212,17 +26941,17 @@ }, "patch": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSsoProvider", + "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -26240,18 +26969,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -26263,7 +26992,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26278,7 +27007,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26297,15 +27026,15 @@ } } }, - "/aggregate/sso-provider": { + "/aggregate/spatial-scene-material": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Material", "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 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": "aggregateSsoProvider", + "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { @@ -26329,7 +27058,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -26343,7 +27072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26361,7 +27090,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -26378,15 +27107,15 @@ } } }, - "/sso-provider-customer": { + "/spatial-scene-object": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "List with basic information of Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -26415,7 +27144,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26434,7 +27163,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -26448,16 +27177,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -26478,7 +27207,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26493,12 +27222,12 @@ }, "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "Create a new Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -26517,14 +27246,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -26536,7 +27265,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26551,7 +27280,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26567,15 +27296,30 @@ } } }, - "/search/sso-provider-customer": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "Search for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchSpatialSceneObject", + "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": { @@ -26588,7 +27332,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -26602,7 +27346,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26620,7 +27364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26637,20 +27381,20 @@ } } }, - "/sso-provider-customer/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "Detailed information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -26660,7 +27404,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -26672,7 +27416,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26687,7 +27431,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26704,17 +27448,17 @@ }, "delete": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "Delete a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -26745,17 +27489,17 @@ }, "patch": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "summary": "Partially update information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -26773,18 +27517,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -26796,7 +27540,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26811,7 +27555,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26830,15 +27574,15 @@ } } }, - "/aggregate/sso-provider-customer": { + "/aggregate/spatial-scene-object": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "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 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": "aggregateSsoProviderCustomer", + "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -26862,7 +27606,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -26876,7 +27620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26894,7 +27638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -26911,14 +27655,15 @@ } } }, - "/subscription": { + "/spatial-scene-primitive": { "get": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "List with basic information of Subscription 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": "getSubscriptionList", + "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", @@ -26947,7 +27692,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26966,7 +27711,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] @@ -26980,16 +27725,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/spatial-scene-primitive?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/spatial-scene-primitive?limit=25&page=2" } } } @@ -27010,7 +27755,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27025,11 +27770,12 @@ }, "post": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Create a new Subscription 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": "createSubscription", + "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", @@ -27048,14 +27794,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -27067,7 +27813,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27082,7 +27828,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27098,14 +27844,30 @@ } } }, - "/search/subscription": { + "/search/spatial-scene-primitive": { "post": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Search for the Subscription 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": "searchSubscription", + "operationId": "searchSpatialScenePrimitive", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -27118,7 +27880,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -27132,7 +27894,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27150,7 +27912,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27167,19 +27929,20 @@ } } }, - "/subscription/{id}": { + "/spatial-scene-primitive/{id}": { "get": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Detailed information about a Subscription 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": "getSubscription", + "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -27189,7 +27952,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -27201,7 +27964,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27216,7 +27979,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27233,16 +27996,17 @@ }, "delete": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Delete a Subscription 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": "deleteSubscription", + "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -27273,16 +28037,17 @@ }, "patch": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Partially update information about a Subscription 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": "updateSubscription", + "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -27300,18 +28065,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -27323,7 +28088,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27338,7 +28103,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27357,14 +28122,15 @@ } } }, - "/aggregate/subscription": { + "/aggregate/spatial-scene-primitive": { "post": { "tags": [ - "Subscription" + "Spatial Scene Primitive", + "Experimental" ], - "summary": "Aggregate for the Subscription 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": "aggregateSubscription", + "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { @@ -27388,7 +28154,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -27402,7 +28168,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27420,7 +28186,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -27437,14 +28203,15 @@ } } }, - "/subscription-address": { + "/sso-provider": { "get": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "List with basic information of Subscription Address 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": "getSubscriptionAddressList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -27473,7 +28240,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27492,7 +28259,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -27506,16 +28273,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -27536,7 +28303,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27551,11 +28318,12 @@ }, "post": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Create a new Subscription Address 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": "createSubscriptionAddress", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -27574,14 +28342,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -27593,7 +28361,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27608,7 +28376,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27624,14 +28392,30 @@ } } }, - "/search/subscription-address": { + "/search/sso-provider": { "post": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Search for the Subscription Address 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": "searchSubscriptionAddress", + "operationId": "searchSsoProvider", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -27644,7 +28428,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -27658,7 +28442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27676,7 +28460,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27693,19 +28477,20 @@ } } }, - "/subscription-address/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Detailed information about a Subscription Address 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": "getSubscriptionAddress", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -27715,7 +28500,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -27727,7 +28512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27742,7 +28527,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27759,16 +28544,17 @@ }, "delete": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Delete a Subscription Address 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": "deleteSubscriptionAddress", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -27799,16 +28585,17 @@ }, "patch": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Partially update information about a Subscription Address 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": "updateSubscriptionAddress", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -27826,18 +28613,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -27849,7 +28636,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27864,7 +28651,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27883,14 +28670,15 @@ } } }, - "/aggregate/subscription-address": { + "/aggregate/sso-provider": { "post": { "tags": [ - "Subscription Address" + "Sso Provider", + "Experimental" ], - "summary": "Aggregate for the Subscription Address 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": "aggregateSubscriptionAddress", + "operationId": "aggregateSsoProvider", "requestBody": { "required": true, "content": { @@ -27914,7 +28702,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -27928,7 +28716,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27946,7 +28734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -27963,14 +28751,15 @@ } } }, - "/subscription-customer": { + "/sso-provider-customer": { "get": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "List with basic information of Subscription Customer 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": "getSubscriptionCustomerList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -27999,7 +28788,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28018,7 +28807,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -28032,16 +28821,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -28062,7 +28851,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28077,11 +28866,12 @@ }, "post": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Create a new Subscription Customer 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": "createSubscriptionCustomer", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -28100,14 +28890,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -28119,7 +28909,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28134,7 +28924,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28150,14 +28940,30 @@ } } }, - "/search/subscription-customer": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Search for the Subscription Customer 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": "searchSubscriptionCustomer", + "operationId": "searchSsoProviderCustomer", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -28170,7 +28976,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -28184,7 +28990,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28202,7 +29008,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28219,19 +29025,20 @@ } } }, - "/subscription-customer/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Detailed information about a Subscription Customer 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": "getSubscriptionCustomer", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -28241,7 +29048,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -28253,7 +29060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28268,7 +29075,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28285,16 +29092,17 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Delete a Subscription Customer 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": "deleteSubscriptionCustomer", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -28325,16 +29133,17 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Partially update information about a Subscription Customer 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": "updateSubscriptionCustomer", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -28352,18 +29161,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -28375,7 +29184,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28390,7 +29199,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28409,14 +29218,15 @@ } } }, - "/aggregate/subscription-customer": { + "/aggregate/sso-provider-customer": { "post": { "tags": [ - "Subscription Customer" + "Sso Provider Customer", + "Experimental" ], - "summary": "Aggregate for the Subscription Customer 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": "aggregateSubscriptionCustomer", + "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -28440,7 +29250,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -28454,7 +29264,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28472,7 +29282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -28489,14 +29299,14 @@ } } }, - "/subscription-interval": { + "/subscription": { "get": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Subscription resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -28525,7 +29335,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28544,7 +29354,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } ] @@ -28558,16 +29368,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -28588,7 +29398,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28603,11 +29413,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Subscription resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -28626,14 +29436,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -28645,7 +29455,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28660,7 +29470,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28676,14 +29486,29 @@ } } }, - "/search/subscription-interval": { + "/search/subscription": { "post": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Subscription resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchSubscription", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -28696,7 +29521,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -28710,7 +29535,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28728,7 +29553,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28745,19 +29570,19 @@ } } }, - "/subscription-interval/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Subscription resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -28767,7 +29592,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -28779,7 +29604,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28794,7 +29619,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28811,16 +29636,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Subscription resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -28851,16 +29676,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Subscription resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -28878,18 +29703,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Subscription resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -28901,7 +29726,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28916,7 +29741,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28935,14 +29760,14 @@ } } }, - "/aggregate/subscription-interval": { + "/aggregate/subscription": { "post": { "tags": [ - "Subscription Interval" + "Subscription" ], - "summary": "Aggregate for the Subscription Interval resources.", + "summary": "Aggregate for the Subscription resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionInterval", + "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { @@ -28966,7 +29791,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -28980,7 +29805,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -28998,7 +29823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/Subscription" } } } @@ -29015,14 +29840,14 @@ } } }, - "/subscription-plan": { + "/subscription-address": { "get": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "List with basic information of Subscription Plan resources.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSubscriptionPlanList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -29051,7 +29876,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29070,7 +29895,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -29084,16 +29909,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -29114,7 +29939,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29129,11 +29954,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Create a new Subscription Plan resources.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSubscriptionPlan", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -29152,14 +29977,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -29171,7 +29996,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29186,7 +30011,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29202,14 +30027,29 @@ } } }, - "/search/subscription-plan": { + "/search/subscription-address": { "post": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Search for the Subscription Plan resources.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSubscriptionPlan", + "operationId": "searchSubscriptionAddress", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -29222,7 +30062,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -29236,7 +30076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29254,7 +30094,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29271,19 +30111,19 @@ } } }, - "/subscription-plan/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Detailed information about a Subscription Plan resource.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSubscriptionPlan", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -29293,7 +30133,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -29305,7 +30145,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29320,7 +30160,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29337,16 +30177,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Delete a Subscription Plan resource.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSubscriptionPlan", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -29377,16 +30217,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Partially update information about a Subscription Plan resource.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSubscriptionPlan", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -29404,18 +30244,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Subscription Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -29427,7 +30267,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29442,7 +30282,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29461,14 +30301,14 @@ } } }, - "/aggregate/subscription-plan": { + "/aggregate/subscription-address": { "post": { "tags": [ - "Subscription Plan" + "Subscription Address" ], - "summary": "Aggregate for the Subscription Plan resources.", + "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionPlan", + "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -29492,7 +30332,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -29506,7 +30346,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29524,7 +30364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -29541,14 +30381,14 @@ } } }, - "/swag-delay-action": { + "/subscription-customer": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "List with basic information of Swag Delay Action resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getSwagDelayActionList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -29577,7 +30417,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29596,7 +30436,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -29610,16 +30450,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -29640,7 +30480,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29655,11 +30495,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Create a new Swag Delay Action resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createSwagDelayAction", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -29678,14 +30518,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -29697,7 +30537,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29712,7 +30552,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29728,14 +30568,29 @@ } } }, - "/search/swag-delay-action": { + "/search/subscription-customer": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Search for the Swag Delay Action resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchSwagDelayAction", + "operationId": "searchSubscriptionCustomer", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -29748,7 +30603,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -29762,7 +30617,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29780,7 +30635,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29797,19 +30652,19 @@ } } }, - "/swag-delay-action/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Detailed information about a Swag Delay Action resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getSwagDelayAction", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -29819,7 +30674,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -29831,7 +30686,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29846,7 +30701,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29863,16 +30718,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Delete a Swag Delay Action resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteSwagDelayAction", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -29903,16 +30758,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Partially update information about a Swag Delay Action resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateSwagDelayAction", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -29930,18 +30785,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Subscription Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -29953,7 +30808,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29968,7 +30823,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -29987,14 +30842,14 @@ } } }, - "/aggregate/swag-delay-action": { + "/aggregate/subscription-customer": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Customer" ], - "summary": "Aggregate for the Swag Delay Action resources.", + "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagDelayAction", + "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -30018,7 +30873,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -30032,7 +30887,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -30050,7 +30905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -30067,14 +30922,14 @@ } } }, - "/warehouse": { + "/subscription-interval": { "get": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "List with basic information of Warehouse resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getWarehouseList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -30103,7 +30958,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30122,7 +30977,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -30136,16 +30991,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/warehouse?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/warehouse?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/warehouse?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -30166,7 +31021,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30181,11 +31036,11 @@ }, "post": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Create a new Warehouse resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createWarehouse", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -30204,14 +31059,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -30223,7 +31078,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30238,7 +31093,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30254,14 +31109,29 @@ } } }, - "/search/warehouse": { + "/search/subscription-interval": { "post": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Search for the Warehouse resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchWarehouse", + "operationId": "searchSubscriptionInterval", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -30274,7 +31144,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -30288,7 +31158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30306,7 +31176,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30323,19 +31193,19 @@ } } }, - "/warehouse/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Detailed information about a Warehouse resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getWarehouse", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -30345,7 +31215,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -30357,7 +31227,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30372,7 +31242,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30389,16 +31259,16 @@ }, "delete": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Delete a Warehouse resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteWarehouse", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -30429,16 +31299,16 @@ }, "patch": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Partially update information about a Warehouse resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateWarehouse", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -30456,18 +31326,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "description": "Partially update information about a Subscription Interval resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -30479,7 +31349,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30494,7 +31364,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30513,14 +31383,14 @@ } } }, - "/aggregate/warehouse": { + "/aggregate/subscription-interval": { "post": { "tags": [ - "Warehouse" + "Subscription Interval" ], - "summary": "Aggregate for the Warehouse resources.", + "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouse", + "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -30544,7 +31414,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -30558,7 +31428,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30576,7 +31446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -30593,14 +31463,14 @@ } } }, - "/warehouse-group": { + "/subscription-plan": { "get": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "List with basic information of Warehouse Group resources.", + "summary": "List with basic information of Subscription Plan resources.", "description": "", - "operationId": "getWarehouseGroupList", + "operationId": "getSubscriptionPlanList", "parameters": [ { "name": "limit", @@ -30629,7 +31499,7 @@ ], "responses": { "200": { - "description": "List of Warehouse Group resources.", + "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30648,7 +31518,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } ] @@ -30662,16 +31532,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse-group?limit=25" + "example": "/subscription-plan?limit=25" }, "last": { - "example": "/warehouse-group?limit=25&page=11" + "example": "/subscription-plan?limit=25&page=11" }, "next": { - "example": "/warehouse-group?limit=25&page=4" + "example": "/subscription-plan?limit=25&page=4" }, "prev": { - "example": "/warehouse-group?limit=25&page=2" + "example": "/subscription-plan?limit=25&page=2" } } } @@ -30692,7 +31562,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30707,11 +31577,11 @@ }, "post": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Create a new Warehouse Group resources.", + "summary": "Create a new Subscription Plan resources.", "description": "", - "operationId": "createWarehouseGroup", + "operationId": "createSubscriptionPlan", "parameters": [ { "name": "_response", @@ -30730,14 +31600,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -30749,7 +31619,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30764,7 +31634,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30780,14 +31650,29 @@ } } }, - "/search/warehouse-group": { + "/search/subscription-plan": { "post": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Search for the Warehouse Group resources.", + "summary": "Search for the Subscription Plan resources.", "description": "", - "operationId": "searchWarehouseGroup", + "operationId": "searchSubscriptionPlan", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { @@ -30800,7 +31685,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -30814,7 +31699,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30832,7 +31717,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30849,19 +31734,19 @@ } } }, - "/warehouse-group/{id}": { + "/subscription-plan/{id}": { "get": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Detailed information about a Warehouse Group resource.", + "summary": "Detailed information about a Subscription Plan resource.", "description": "", - "operationId": "getWarehouseGroup", + "operationId": "getSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -30871,7 +31756,7 @@ ], "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -30883,7 +31768,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30898,7 +31783,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -30915,16 +31800,16 @@ }, "delete": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Delete a Warehouse Group resource.", + "summary": "Delete a Subscription Plan resource.", "description": "", - "operationId": "deleteWarehouseGroup", + "operationId": "deleteSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -30955,16 +31840,16 @@ }, "patch": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Partially update information about a Warehouse Group resource.", + "summary": "Partially update information about a Subscription Plan resource.", "description": "", - "operationId": "updateWarehouseGroup", + "operationId": "updateSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -30982,18 +31867,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "description": "Partially update information about a Subscription Plan resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -31005,7 +31890,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -31020,7 +31905,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -31039,14 +31924,14 @@ } } }, - "/aggregate/warehouse-group": { + "/aggregate/subscription-plan": { "post": { "tags": [ - "Warehouse Group" + "Subscription Plan" ], - "summary": "Aggregate for the Warehouse Group resources.", + "summary": "Aggregate for the Subscription Plan resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouseGroup", + "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -31070,7 +31955,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -31084,7 +31969,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -31102,7 +31987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -31119,494 +32004,1772 @@ } } }, - "/_action/media/upload": { - "post": { + "/swag-delay-action": { + "get": { "tags": [ - "Asset Management" + "Swag Delay Action" ], - "summary": "Upload a new media file", - "description": "Creates a new media entity and uploads a file to it using form-data file upload.", - "operationId": "uploadV2", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file to upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" - } - }, - "required": [ - "file" - ] - } + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "List of Swag Delay Action resources.", "content": { - "application\\/json": { + "application/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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } } } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/media/upload_by_url": { + }, "post": { "tags": [ - "Asset Management" + "Swag Delay Action" + ], + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Upload a media file from URL", - "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", - "operationId": "uploadByUrl", "requestBody": { "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "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" - ] + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "Detail of SwagDelayAction", "content": { - "application\\/json": { + "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "data": { + "$ref": "#/components/schemas/SwagDelayAction" } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/media/external-link": { + "/search/swag-delay-action": { "post": { "tags": [ - "Asset Management" + "Swag Delay Action" + ], + "summary": "Search for the Swag Delay Action resources.", + "description": "", + "operationId": "searchSwagDelayAction", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } ], - "summary": "Create external media link", - "description": "Creates a new media entity that links to an external URL without downloading the file.", - "operationId": "externalLink", "requestBody": { + "required": true, "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "URL of the external media file" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on path" - } - }, - "required": [ - "url", - "mimeType" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "External media link created successfully", + "description": "List of SwagDelayAction", "content": { - "application\\/json": { + "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } } - } + ] } - } - } - } - } - } - }, - "/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" - } + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" } } } - }, - "example": { - "privileges": { - "SwagAnalytics": [ - "customer:read", - "order:read" - ], - "SwagExample": [ - "product:write" - ] - } } } } }, "400": { - "description": "Malformed request." + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." + "$ref": "#/components/responses/401" } } } }, - "/app-system/{appName}/privileges/accepted": { + "/swag-delay-action/{id}": { "get": { "tags": [ - "App System" + "Swag Delay Action" ], - "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": "Detailed information about a Swag Delay Action resource.", + "description": "", + "operationId": "getSwagDelayAction", "parameters": [ { - "name": "appName", + "name": "id", "in": "path", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], - "security": [ - { - "oAuth": [ - "admin" - ] - } - ], "responses": { "200": { - "description": "A JSON object containing accepted privileges.", + "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": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "boolean" - } + "data": { + "$ref": "#/components/schemas/SwagDelayAction" } } - }, - "example": { - "privileges": { - "customer:read": true, - "order:read": true - } } } } }, - "400": { - "description": "Malformed request." + "404": { + "$ref": "#/components/responses/404" }, "401": { - "description": "Unauthorized Access." + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "403": { - "description": "Forbidden. Not a valid integration source." + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" }, "404": { - "description": "App not found." + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/app-system/{appName}/privileges": { + }, "patch": { "tags": [ - "App System" + "Swag Delay Action" ], - "summary": "Accept or revoke privileges for an app", - "description": "Accepts or revokes specified privileges for the given app.", - "operationId": "managePrivileges", + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", "parameters": [ { - "name": "appName", + "name": "id", "in": "path", + "description": "Identifier for the swag_delay_action", "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { - "required": true, + "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "accept": { - "type": "array", - "items": { - "type": "string" - } - }, - "revoke": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-delay-action": { + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Aggregate for the Swag Delay Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagDelayAction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Warehouse resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/warehouse?limit=25" + }, + "last": { + "example": "/warehouse?limit=25&page=11" + }, + "next": { + "example": "/warehouse?limit=25&page=4" + }, + "prev": { + "example": "/warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Create a new Warehouse resources.", + "description": "", + "operationId": "createWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Search for the Warehouse resources.", + "description": "", + "operationId": "searchWarehouse", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse/{id}": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "Detailed information about a Warehouse resource.", + "description": "", + "operationId": "getWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse" + ], + "summary": "Delete a Warehouse resource.", + "description": "", + "operationId": "deleteWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Warehouse" + ], + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Warehouse resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Aggregate for the Warehouse resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWarehouse", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse-group": { + "get": { + "tags": [ + "Warehouse Group" + ], + "summary": "List with basic information of Warehouse Group resources.", + "description": "", + "operationId": "getWarehouseGroupList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Warehouse Group resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/warehouse-group?limit=25" + }, + "last": { + "example": "/warehouse-group?limit=25&page=11" + }, + "next": { + "example": "/warehouse-group?limit=25&page=4" + }, + "prev": { + "example": "/warehouse-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Warehouse Group" + ], + "summary": "Create a new Warehouse Group resources.", + "description": "", + "operationId": "createWarehouseGroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } } - } + ] } }, - "example": { - "accept": [ - "customer:read", - "order:read" - ], - "revoke": [ - "product:write" - ] + "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": { - "204": { - "description": "Returns no content if privileges were managed successfully." + "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": { - "description": "Malformed request." + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] + "$ref": "#/components/responses/401" } - ] + } } }, - "/_action/theme/{themeId}": { - "patch": { + "/warehouse-group/{id}": { + "get": { "tags": [ - "Theme" + "Warehouse Group" ], - "summary": "Update theme configuration", - "description": "Updates the configuration of a theme. The theme configuration is a collection of fields that are provided as variables in the theme's SCSS files and the templates.", - "operationId": "updateThemeConfiguration", + "summary": "Detailed information about a Warehouse Group resource.", + "description": "", + "operationId": "getWarehouseGroup", "parameters": [ { - "name": "themeId", - "description": "The ID of the theme to update", + "name": "id", "in": "path", + "description": "Identifier for the warehouse_group", "required": true, "schema": { - "type": "string" + "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": "parentThemeId", - "description": "The ID of the parent theme to inherit the configuration from.", - "in": "query", - "required": false, + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "reset", - "description": "If true, the theme configuration will be reset to the default values from the theme.json file.", + "name": "_response", "in": "query", - "required": false, + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "boolean" + "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": "validate", - "description": "If true, the theme configuration will be validated before being updated.", - "in": "query", - "required": false, + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "sanitize", - "description": "If true, the theme configuration will be sanitized during validation. before being updated. Only applies if validate is true.", + "name": "_response", "in": "query", - "required": false, + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "boolean" + "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" } + } + } + }, + "/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": "Theme updated successfully.", + "description": "List of consents with their status", "content": { "application/json": { "schema": { - "type": "object" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "requested", + "actor": null, + "updatedAt": null + } + } + } + } + } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" + } + } + } + }, + "/consents/accept": { + "post": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } + } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" + } + } + } + }, + "/consents/revoke": { + "post": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" } } } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } @@ -31730,6 +33893,71 @@ } } }, + "/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": [ @@ -32666,9 +34894,11 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { @@ -32678,6 +34908,7 @@ } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -32804,9 +35035,11 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { @@ -32816,6 +35049,7 @@ } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -34392,34 +36626,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -34439,9 +36682,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -34451,6 +36696,7 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, @@ -34491,10 +36737,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34906,34 +37154,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -34953,9 +37210,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -34965,6 +37224,7 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, @@ -35005,10 +37265,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35073,29 +37335,420 @@ "$ref": "#/components/schemas/AppCmsBlock" } }, - "flowActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + }, + "type": "object" + }, + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppActionButton": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "translated": { + "type": "object" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AppActionButtonJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35103,11 +37756,9 @@ { "required": [ "id", - "entity", - "view", - "url", - "action", "appId", + "name", + "url", "label" ], "properties": { @@ -35115,24 +37766,62 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", "type": "string" }, - "view": { + "badge": { "type": "string" }, - "url": { + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { "type": "string" }, - "action": { + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", "type": "string" }, + "delayable": { + "type": "boolean" + }, "label": { "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -35157,7 +37846,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, @@ -35177,6 +37866,37 @@ } }, "type": "object" + }, + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -35186,15 +37906,13 @@ } ] }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ "id", - "entity", - "view", - "url", - "action", "appId", + "name", + "url", "label" ], "properties": { @@ -35202,24 +37920,62 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", "type": "string" }, - "view": { + "badge": { "type": "string" }, - "url": { + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { "type": "string" }, - "action": { + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { "type": "string" }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, "label": { "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -35236,12 +37992,18 @@ }, "app": { "$ref": "#/components/schemas/App" + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } } }, "type": "object" }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35249,25 +38011,32 @@ { "required": [ "id", - "value", "appId", - "localeId" + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" - }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -35278,35 +38047,107 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "flows": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "example": "0db2dd944f9ee9a131f44b79d331d371" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ "id", - "value", "appId", - "localeId" + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" - }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -35317,12 +38158,21 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } }, "type": "object" }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35330,34 +38180,59 @@ { "required": [ "id", - "name", - "block", - "template", - "styles", - "appId", - "label" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { + "description": "Name of the app.", "type": "string" }, - "block": { - "type": "object" + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" }, - "template": { + "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, - "styles": { + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, - "label": { + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35371,9 +38246,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "app": { @@ -35384,7 +38256,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, @@ -35404,6 +38276,64 @@ } }, "type": "object" + }, + "originalMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" + } + } + } + }, + "type": "object" + }, + "paymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -35413,38 +38343,63 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", "required": [ "id", - "name", - "block", - "template", - "styles", - "appId", - "label" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { + "description": "Name of the app.", "type": "string" }, - "block": { - "type": "object" + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" }, - "template": { + "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, - "styles": { + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, - "label": { + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35458,17 +38413,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "app": { "$ref": "#/components/schemas/App" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35476,70 +38434,43 @@ { "required": [ "id", + "identifier", + "active", "appId", - "name", - "url", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, - "url": { + "name": { "type": "string" }, - "delayable": { - "type": "boolean" - }, - "label": { - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" }, - "description": { + "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, - "headline": { + "script": { + "description": "Internal field.", "type": "string" }, - "customFields": { + "config": { "type": "object" }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -35563,7 +38494,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, @@ -35584,7 +38515,7 @@ }, "type": "object" }, - "flowSequences": { + "ruleConditions": { "properties": { "links": { "type": "object", @@ -35592,7 +38523,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, @@ -35603,11 +38534,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "rule_condition" }, "id": { "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + "example": "24bfabce4195894c9aed9b8bcfb0b748" } } } @@ -35623,74 +38554,47 @@ } ] }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", "required": [ "id", + "identifier", + "active", "appId", - "name", - "url", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, - "url": { + "name": { "type": "string" }, - "delayable": { + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, - "label": { - "type": "string" - }, - "description": { + "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, - "headline": { + "script": { + "description": "Internal field.", "type": "string" }, - "customFields": { + "config": { "type": "object" }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -35707,17 +38611,17 @@ "app": { "$ref": "#/components/schemas/App" }, - "flowSequences": { + "ruleConditions": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35725,30 +38629,32 @@ { "required": [ "id", - "appId", - "name", - "aware" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -35770,7 +38676,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" } } }, @@ -35791,7 +38697,7 @@ }, "type": "object" }, - "flows": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -35799,23 +38705,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "originalMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" } } } @@ -35830,34 +38763,36 @@ } ] }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", "required": [ "id", - "appId", - "name", - "aware" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -35872,17 +38807,17 @@ "app": { "$ref": "#/components/schemas/App" }, - "flows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "AppPaymentMethodJsonApi": { - "description": "Added since version: 6.4.1.0", + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -35890,50 +38825,35 @@ { "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "template", + "path", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "payUrl": { - "type": "string" - }, - "finalizeUrl": { - "type": "string" - }, - "validateUrl": { - "type": "string" - }, - "captureUrl": { + "template": { + "description": "Template for an app.", "type": "string" }, - "refundUrl": { + "path": { + "description": "A relative URL to the app template.", "type": "string" }, - "recurringUrl": { - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "hash": { + "type": "string" }, "createdAt": { "type": "string", @@ -35955,7 +38875,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, @@ -35975,8 +38895,103 @@ } }, "type": "object" - }, - "originalMedia": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppTemplate": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "template", + "path", + "active", + "appId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "B2bBusinessPartnerJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { "properties": { "links": { "type": "object", @@ -35984,7 +38999,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" } } }, @@ -35993,19 +39008,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "paymentMethod": { + "defaultRole": { "properties": { "links": { "type": "object", @@ -36013,7 +39028,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" } } }, @@ -36022,12 +39037,12 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "example": "2944ea414640901d532eba5106eb706b" } } } @@ -36042,54 +39057,25 @@ } ] }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", + "B2bBusinessPartner": { "required": [ - "id", - "appName", - "identifier", - "paymentMethodId" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "payUrl": { - "type": "string" - }, - "finalizeUrl": { - "type": "string" - }, - "validateUrl": { - "type": "string" - }, - "captureUrl": { - "type": "string" - }, - "refundUrl": { - "type": "string" - }, - "recurringUrl": { - "type": "string" - }, - "appId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { + "defaultRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -36101,20 +39087,17 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "defaultRole": { + "$ref": "#/components/schemas/B2bComponentsRole" } }, "type": "object" }, - "AppScriptConditionJsonApi": { - "description": "Added since version: 6.4.10.3", + "B2bComponentsAdvancedProductCatalogsJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -36122,35 +39105,31 @@ { "required": [ "id", - "identifier", - "active", - "appId", - "name" + "customerId", + "organizationId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { + "autoAddNewCategories": { "type": "boolean" }, - "group": { - "type": "string" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "script": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36164,12 +39143,67 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "customerGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customerGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "115091b01a7299f28a5ce7e1b712a222" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "organization": { "properties": { "links": { "type": "object", @@ -36177,7 +39211,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/organization" } } }, @@ -36186,19 +39220,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, - "ruleConditions": { + "createdBy": { "properties": { "links": { "type": "object", @@ -36206,7 +39240,123 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannels" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/advancedProductCatalogsCategories" } } }, @@ -36217,11 +39367,42 @@ "properties": { "type": { "type": "string", - "example": "rule_condition" + "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", - "example": "24bfabce4195894c9aed9b8bcfb0b748" + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } @@ -36237,39 +39418,35 @@ } ] }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", + "B2bComponentsAdvancedProductCatalogs": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "identifier", - "active", - "appId", - "name" + "customerId", + "organizationId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { + "autoAddNewCategories": { "type": "boolean" }, - "group": { - "type": "string" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "script": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36283,23 +39460,75 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "app": { - "$ref": "#/components/schemas/App" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "ruleConditions": { + "organization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "salesChannels": { + "$ref": "#/components/schemas/SalesChannel" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "advancedProductCatalogsCategories": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogsCategory" + } + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" } } }, "type": "object" }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", + "B2bComponentsAdvancedProductCatalogsCategory": { + "required": [ + "advancedProductCatalogsId", + "categoryId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "advancedProductCatalogsId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "advancedProductCatalog": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" + }, + "category": { + "$ref": "#/components/schemas/Category" + } + }, + "type": "object" + }, + "B2bComponentsApprovalRuleJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -36307,33 +39536,47 @@ { "required": [ "id", - "appName", - "identifier", - "shippingMethodId" + "name", + "priority", + "active", + "conditions" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "identifier": { + "description": { "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "shippingMethodId": { + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -36346,7 +39589,7 @@ }, "relationships": { "properties": { - "app": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -36354,7 +39597,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" } } }, @@ -36363,19 +39606,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" }, - "shippingMethod": { + "reviewerRole": { "properties": { "links": { "type": "object", @@ -36383,7 +39626,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" } } }, @@ -36392,19 +39635,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "06ec286ee4d03afb4028caa32c0ef40b" } } } }, "type": "object" }, - "originalMedia": { + "affectedRole": { "properties": { "links": { "type": "object", @@ -36412,7 +39655,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" } } }, @@ -36421,12 +39664,43 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "example": "33237c6057eedd7b8c978f77270af3b1" + } + } + } + }, + "type": "object" + }, + "pendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "2a7cfaa402d9b52e7ecd072ae390d84b" + } } } } @@ -36441,37 +39715,51 @@ } ] }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", + "B2bComponentsApprovalRule": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "appName", - "identifier", - "shippingMethodId" + "name", + "priority", + "active", + "conditions" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "identifier": { + "description": { "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "shippingMethodId": { + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -36482,20 +39770,26 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "affectedRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "pendingOrders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } } }, "type": "object" }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", + "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { + "description": "Added since version: 6.6.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -36503,32 +39797,38 @@ { "required": [ "id", - "template", - "path", + "identifier", "active", - "appId" + "appId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { + "identifier": { "type": "string" }, - "path": { + "name": { "type": "string" }, "active": { "type": "boolean" }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { + "type": "object" + }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36539,6 +39839,9 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { "app": { @@ -36549,7 +39852,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" } } }, @@ -36578,36 +39881,42 @@ } ] }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", + "B2bComponentsApprovalRuleAppScriptCondition": { + "description": "Added since version: 6.6.3.0", "required": [ "id", - "template", - "path", + "identifier", "active", - "appId" + "appId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { + "identifier": { "type": "string" }, - "path": { + "name": { "type": "string" }, "active": { "type": "boolean" }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { + "type": "object" + }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36618,36 +39927,115 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, - "B2bBusinessPartnerJsonApi": { + "B2bComponentsBudgetJsonApi": { + "description": "Added since version: 6.7.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "id" + "id", + "name", + "technicalName", + "amount", + "startDate", + "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "costCentre": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "amount": { + "type": "number", + "format": "float" + }, + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "renewsType": { + "type": "string" + }, + "lastRenews": { + "type": "string", + "readOnly": true + }, + "nextRenews": { + "type": "string", + "readOnly": true + }, + "allowApproval": { + "type": "boolean" + }, + "showRemaining": { + "type": "boolean" + }, + "notify": { + "type": "boolean" + }, + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "sent": { + "type": "boolean", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -36661,7 +40049,7 @@ }, "relationships": { "properties": { - "customer": { + "createdBy": { "properties": { "links": { "type": "object", @@ -36669,7 +40057,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/createdBy" } } }, @@ -36678,19 +40066,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "defaultRole": { + "organizations": { "properties": { "links": { "type": "object", @@ -36698,7 +40086,69 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/organizations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "d9811f03b461a380c0d6b4a497dbac37" + } + } + } + } + }, + "type": "object" + }, + "notificationRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/notificationRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "bd4a2b3045182246fac51c0abc10c4d7" + } + } + } + } + }, + "type": "object" + }, + "reviewerRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/reviewerRole" } } }, @@ -36712,7 +40162,36 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2944ea414640901d532eba5106eb706b" + "example": "06ec286ee4d03afb4028caa32c0ef40b" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } @@ -36727,25 +40206,101 @@ } ] }, - "B2bBusinessPartner": { + "B2bComponentsBudget": { + "description": "Added since version: 6.7.4.0", "required": [ - "id" + "id", + "name", + "technicalName", + "amount", + "startDate", + "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "costCentre": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "amount": { + "type": "number", + "format": "float" + }, + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "renewsType": { + "type": "string" + }, + "lastRenews": { + "type": "string", + "readOnly": true + }, + "nextRenews": { + "type": "string", + "readOnly": true + }, + "allowApproval": { + "type": "boolean" + }, + "showRemaining": { + "type": "boolean" + }, + "notify": { + "type": "boolean" + }, + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "sent": { + "type": "boolean", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -36757,17 +40312,87 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "createdBy": { + "$ref": "#/components/schemas/User" }, - "defaultRole": { + "organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + }, + "notificationRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "reviewerRole": { "$ref": "#/components/schemas/B2bComponentsRole" + }, + "currency": { + "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "B2bComponentsApprovalRuleJsonApi": { - "description": "Added since version: 6.6.0.0", + "B2bComponentsBudgetNotificationRecipient": { + "description": "Added since version: 6.7.4.0", + "required": [ + "budgetId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budgetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budget": { + "$ref": "#/components/schemas/B2bComponentsBudget" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "type": "object" + }, + "B2bComponentsBudgetOrganization": { + "description": "Added since version: 6.7.4.0", + "required": [ + "budgetId", + "organizationId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budgetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budget": { + "$ref": "#/components/schemas/B2bComponentsBudget" + }, + "organization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + }, + "type": "object" + }, + "B2bComponentsEmployeeWishlistJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -36775,43 +40400,24 @@ { "required": [ "id", - "name", - "priority", - "active", - "conditions" + "employeeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "affectedRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -36825,36 +40431,7 @@ }, "relationships": { "properties": { - "businessPartnerCustomer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" - } - } - } - }, - "type": "object" - }, - "reviewerRole": { + "employee": { "properties": { "links": { "type": "object", @@ -36862,7 +40439,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/employee" } } }, @@ -36871,19 +40448,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06ec286ee4d03afb4028caa32c0ef40b" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, - "affectedRole": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -36891,7 +40468,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/salesChannel" } } }, @@ -36900,19 +40477,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "33237c6057eedd7b8c978f77270af3b1" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "pendingOrders": { + "products": { "properties": { "links": { "type": "object", @@ -36920,7 +40497,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/products" } } }, @@ -36931,11 +40508,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", - "example": "2a7cfaa402d9b52e7ecd072ae390d84b" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -36951,47 +40528,27 @@ } ] }, - "B2bComponentsApprovalRule": { - "description": "Added since version: 6.6.0.0", + "B2bComponentsEmployeeWishlist": { "required": [ "id", - "name", - "priority", - "active", - "conditions" + "employeeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "affectedRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -37003,26 +40560,22 @@ "format": "date-time", "readOnly": true }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" - }, - "reviewerRole": { - "$ref": "#/components/schemas/B2bComponentsRole" + "employee": { + "$ref": "#/components/schemas/B2bEmployee" }, - "affectedRole": { - "$ref": "#/components/schemas/B2bComponentsRole" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "pendingOrders": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } }, "type": "object" }, - "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { - "description": "Added since version: 6.6.3.0", + "B2bComponentsEmployeeWishlistProductJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -37030,38 +40583,30 @@ { "required": [ "id", - "identifier", - "active", - "appId", - "name" + "employeeWishlistId", + "productId", + "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" + "employeeWishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -37072,12 +40617,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "employeeWishlist": { "properties": { "links": { "type": "object", @@ -37085,7 +40627,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" + "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/employeeWishlist" } } }, @@ -37094,12 +40636,41 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "b2b_components_employee_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "396edf0709663088597d101284333942" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -37114,42 +40685,33 @@ } ] }, - "B2bComponentsApprovalRuleAppScriptCondition": { - "description": "Added since version: 6.6.3.0", + "B2bComponentsEmployeeWishlistProduct": { "required": [ "id", - "identifier", - "active", - "appId", - "name" + "employeeWishlistId", + "productId", + "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" + "employeeWishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -37160,11 +40722,11 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "employeeWishlist": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" }, - "app": { - "$ref": "#/components/schemas/App" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" @@ -37223,6 +40785,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "customer": { @@ -37551,6 +41149,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "customer": { "$ref": "#/components/schemas/Customer" }, @@ -37983,6 +41617,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "order": { @@ -38616,6 +42284,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "order": { "$ref": "#/components/schemas/Order" }, @@ -39941,6 +43643,146 @@ }, "type": "object" }, + "B2bComponentsSubscriptionEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "subscriptionId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "subscription": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/subscription" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + } + } + } + }, + "type": "object" + }, + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/employee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsSubscriptionEmployee": { + "required": [ + "id", + "subscriptionId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "subscription": { + "$ref": "#/components/schemas/Subscription" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "type": "object" + }, "B2bEmployeeJsonApi": { "allOf": [ { @@ -40829,6 +44671,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40837,10 +44680,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -40857,11 +44702,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -40871,15 +44718,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -40926,6 +44777,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40934,6 +44786,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40958,6 +44811,68 @@ "properties": { "search": { "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -40965,6 +44880,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -40994,6 +44910,7 @@ "type": "object" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -41025,6 +44942,7 @@ "type": "object" }, "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -41116,6 +45034,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -41147,6 +45066,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -41329,6 +45249,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -41391,6 +45312,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41399,10 +45321,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -41419,11 +45343,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -41433,15 +45359,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -41488,6 +45418,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41496,6 +45427,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41520,21 +45452,86 @@ "properties": { "search": { "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, "parent": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, "children": { + "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, "products": { "type": "array", @@ -41549,13 +45546,15 @@ } }, "tags": { + "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" @@ -41585,6 +45584,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -41652,44 +45652,56 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -41707,6 +45719,7 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41844,44 +45857,56 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -41899,6 +45924,7 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41954,12 +45980,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -41971,6 +46000,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41996,6 +46026,7 @@ "relationships": { "properties": { "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -42027,6 +46058,7 @@ "type": "object" }, "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -42087,6 +46119,7 @@ "type": "object" }, "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -42206,12 +46239,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -42223,6 +46259,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42246,13 +46283,15 @@ "type": "object" }, "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, "categories": { "type": "array", @@ -42261,6 +46300,7 @@ } }, "landingPages": { + "description": "Landing pages using this CMS layout", "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" @@ -42308,38 +46348,48 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42491,38 +46541,48 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42598,9 +46658,11 @@ "type": "object" }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -42617,6 +46679,7 @@ "readOnly": true }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42697,9 +46760,11 @@ "type": "object" }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -42716,6 +46781,7 @@ "readOnly": true }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42759,34 +46825,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -42833,21 +46909,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -42967,6 +47048,7 @@ "relationships": { "properties": { "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -43207,34 +47289,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -43281,21 +47373,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -43413,6 +47510,7 @@ "type": "object" }, "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { "$ref": "#/components/schemas/CountryState" @@ -43476,20 +47574,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -43690,20 +47792,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -43830,13 +47936,16 @@ "pattern": "^[0-9a-f]{32}$" }, "factor": { + "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { @@ -43846,6 +47955,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -43854,6 +47964,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -44258,13 +48369,16 @@ "pattern": "^[0-9a-f]{32}$" }, "factor": { + "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { @@ -44274,6 +48388,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -44282,6 +48397,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -44734,6 +48850,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -44743,10 +48860,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44759,9 +48878,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -44796,6 +48917,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -44805,10 +48927,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44821,9 +48945,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -44861,30 +48987,39 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -44978,30 +49113,39 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -45041,22 +49185,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45214,22 +49363,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45285,10 +49439,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -45353,10 +49509,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -45594,26 +49752,32 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45623,77 +49787,98 @@ "readOnly": true }, "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for customer recovery.", "type": "string" }, "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { + "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true @@ -45702,6 +49887,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -45713,10 +49899,12 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46176,6 +50364,7 @@ "relationships": { "properties": { "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -46234,6 +50423,7 @@ "type": "object" }, "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -46263,6 +50453,7 @@ "type": "object" }, "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -46292,6 +50483,7 @@ "type": "object" }, "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -46321,6 +50513,7 @@ "type": "object" }, "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { "links": { "type": "object", @@ -46350,6 +50543,7 @@ "type": "object" }, "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -46379,6 +50573,7 @@ "type": "object" }, "activeShippingAddress": { + "description": "Currently active shipping address in the session", "properties": { "links": { "type": "object", @@ -46408,6 +50603,7 @@ "type": "object" }, "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -46437,6 +50633,7 @@ "type": "object" }, "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -46499,6 +50696,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -46795,26 +50993,32 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46824,77 +51028,98 @@ "readOnly": true }, "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for customer recovery.", "type": "string" }, "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { + "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true @@ -46903,6 +51128,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -46914,10 +51140,12 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -47375,33 +51603,42 @@ "type": "object" }, "group": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, "salutation": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, "addresses": { + "description": "All addresses saved for the customer", "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" @@ -47414,6 +51651,7 @@ } }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -47477,52 +51715,67 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { + "description": "Name of customer's city.", "type": "string" }, "company": { + "description": "Name of customer's company.", "type": "string" }, "street": { + "description": "Name of customer's street.", "type": "string" }, "department": { + "description": "Name of customer's department.", "type": "string" }, "title": { + "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { + "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional customer's address information.", "type": "string" }, "hash": { @@ -47783,52 +52036,67 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { + "description": "Name of customer's city.", "type": "string" }, "company": { + "description": "Name of customer's company.", "type": "string" }, "street": { + "description": "Name of customer's street.", "type": "string" }, "department": { + "description": "Name of customer's department.", "type": "string" }, "title": { + "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { + "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional customer's address information.", "type": "string" }, "hash": { @@ -47981,12 +52249,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -48168,12 +52438,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -48309,9 +52581,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48377,9 +52651,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48551,10 +52827,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48683,10 +52961,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48736,6 +53016,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48744,6 +53025,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48838,6 +53120,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48846,6 +53129,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48891,14 +53175,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -49007,14 +53294,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -49413,26 +53703,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { + "description": "Unique number associated with every document.", "type": "string" }, "config": { @@ -49483,6 +53780,7 @@ "type": "object" }, "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -49563,26 +53861,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { + "description": "Unique number associated with every document.", "type": "string" }, "config": { @@ -49605,7 +53910,8 @@ "$ref": "#/components/schemas/DocumentType" }, "logo": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." }, "salesChannels": { "type": "array", @@ -49633,14 +53939,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49763,14 +54072,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49817,6 +54129,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -49990,6 +54303,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -50083,29 +54397,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50238,29 +54559,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50339,24 +54667,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -50512,6 +54845,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -50620,24 +54954,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -50739,7 +55078,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -50770,6 +55110,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -50802,6 +55143,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -50839,20 +55181,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -50918,20 +55265,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -51280,21 +55632,26 @@ "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -51383,21 +55740,26 @@ "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -51450,25 +55812,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -51633,25 +56001,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -51847,6 +56221,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -51907,6 +56282,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -52013,7 +56389,8 @@ } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", @@ -52022,6 +56399,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -52116,14 +56494,17 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, "active": { @@ -52336,6 +56717,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -52365,6 +56747,7 @@ "type": "object" }, "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -52394,6 +56777,7 @@ "type": "object" }, "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -52423,6 +56807,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -52786,14 +57171,17 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, "active": { @@ -53004,15 +57392,19 @@ "type": "object" }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, "children": { + "description": "Child languages inheriting from this parent language", "type": "array", "items": { "$ref": "#/components/schemas/Language" @@ -53097,6 +57489,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -53207,6 +57600,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -53262,9 +57656,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -53303,9 +57699,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -53726,6 +58124,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -53807,6 +58206,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -53859,6 +58259,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53867,6 +58268,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53875,6 +58277,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53999,6 +58402,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54007,6 +58411,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54015,6 +58420,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54339,28 +58745,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -54394,6 +58807,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -54669,6 +59083,7 @@ "type": "object" }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -55284,6 +59699,37 @@ }, "type": "object" }, + "a11yDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "f6c460e0d75110fa1ec7529fe364dbb5" + } + } + } + } + }, + "type": "object" + }, "appPaymentMethods": { "properties": { "links": { @@ -55365,28 +59811,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -55420,6 +59873,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -55668,6 +60122,7 @@ } }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" @@ -55781,6 +60236,12 @@ "$ref": "#/components/schemas/Document" } }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, "appPaymentMethods": { "type": "array", "items": { @@ -55947,6 +60408,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -56013,6 +60475,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -56052,13 +60515,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -56072,10 +60538,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -56094,6 +60562,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -56263,13 +60732,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -56283,10 +60755,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -56303,7 +60777,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -56342,16 +60817,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -56453,16 +60932,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -56571,6 +61054,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -56579,17 +61063,19 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -56690,6 +61176,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -56698,17 +61185,19 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -56754,10 +61243,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -56859,10 +61350,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -56915,48 +61408,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57114,48 +61620,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57233,12 +61752,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -57249,10 +61771,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57347,12 +61871,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -57363,10 +61890,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57410,10 +61939,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -57423,9 +61954,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -57560,10 +62093,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -57573,9 +62108,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -57628,14 +62165,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57759,14 +62299,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57810,6 +62353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57879,6 +62423,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57920,12 +62465,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -58029,12 +62576,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -58102,9 +62651,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58129,22 +62680,27 @@ "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -58186,21 +62742,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -58262,36 +62822,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", "type": "string" }, "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58305,10 +62873,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58395,6 +62965,37 @@ }, "type": "object" }, + "initialSubscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" + }, "delayActions": { "properties": { "links": { @@ -58638,6 +63239,35 @@ } }, "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" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -58645,6 +63275,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -58674,6 +63305,7 @@ "type": "object" }, "primaryOrderDelivery": { + "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", @@ -58703,6 +63335,7 @@ "type": "object" }, "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", "properties": { "links": { "type": "object", @@ -58732,6 +63365,7 @@ "type": "object" }, "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -58761,6 +63395,7 @@ "type": "object" }, "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -58790,6 +63425,7 @@ "type": "object" }, "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -58848,6 +63484,7 @@ "type": "object" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -58879,6 +63516,7 @@ "type": "object" }, "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -58908,6 +63546,7 @@ "type": "object" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -58939,6 +63578,7 @@ "type": "object" }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -58970,6 +63610,7 @@ "type": "object" }, "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -59001,6 +63642,7 @@ "type": "object" }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -59032,6 +63674,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -59157,9 +63800,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59184,22 +63829,27 @@ "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -59241,21 +63891,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -59317,36 +63971,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", "type": "string" }, "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59360,10 +64022,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59450,6 +64114,37 @@ }, "type": "object" }, + "initialSubscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" + }, "delayActions": { "properties": { "links": { @@ -59693,65 +64388,107 @@ } }, "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" + } + } + } + }, + "type": "object" } }, "type": "object" }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, "primaryOrderDelivery": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" }, "primaryOrderTransaction": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "transactions": { + "description": "Payment transactions for the order", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -59792,14 +64529,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59808,43 +64548,56 @@ "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" }, "vatId": { + "description": "Unique identity of VAT.", "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": { @@ -60042,14 +64795,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60058,43 +64814,56 @@ "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" }, "vatId": { + "description": "Unique identity of VAT.", "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": { @@ -60159,10 +64928,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60171,22 +64942,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -60196,12 +64973,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -60330,10 +65109,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60342,22 +65123,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -60367,12 +65154,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -60423,6 +65212,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60431,6 +65221,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60439,10 +65230,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60453,10 +65246,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -60533,6 +65328,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -60591,6 +65387,7 @@ "type": "object" }, "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -60620,6 +65417,7 @@ "type": "object" }, "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -60649,6 +65447,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -60737,6 +65536,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60745,6 +65545,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60753,10 +65554,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60767,10 +65570,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -60845,18 +65650,22 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -60890,6 +65699,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60898,6 +65708,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60963,14 +65774,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -61072,6 +65886,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61080,6 +65895,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61145,14 +65961,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -61191,9 +66010,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -61205,6 +66024,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61213,6 +66033,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61221,6 +66042,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61233,44 +66055,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -61332,22 +66157,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -61426,6 +66262,7 @@ "relationships": { "properties": { "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -61484,6 +66321,7 @@ "type": "object" }, "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -61542,6 +66380,7 @@ "type": "object" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -61604,6 +66443,7 @@ "type": "object" }, "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -61710,9 +66550,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -61724,6 +66564,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61732,6 +66573,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61740,6 +66582,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61752,44 +66595,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -61851,22 +66697,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -61943,18 +66800,21 @@ "type": "object" }, "cover": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "product": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -61967,6 +66827,7 @@ } }, "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -62008,6 +66869,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62016,14 +66878,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -62126,6 +66991,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62134,14 +67000,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -63459,6 +68328,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63467,6 +68337,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63531,6 +68402,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63550,6 +68422,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -63608,6 +68481,7 @@ "type": "object" }, "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -63637,6 +68511,7 @@ "type": "object" }, "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -63723,6 +68598,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63731,6 +68607,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63795,6 +68672,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63812,15 +68690,18 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" @@ -63855,6 +68736,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -63863,10 +68745,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -64056,6 +68940,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64064,10 +68949,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -64178,6 +69065,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64186,13 +69074,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -64382,6 +69273,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64390,13 +69282,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -64507,6 +69402,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64515,6 +69411,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64523,12 +69420,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -64688,6 +69588,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64696,6 +69597,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64704,12 +69606,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -64966,10 +69871,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -64983,23 +69890,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65160,6 +70072,7 @@ "relationships": { "properties": { "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -65420,10 +70333,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -65437,23 +70352,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65612,7 +70532,8 @@ "type": "object" }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" @@ -65671,46 +70592,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -65804,46 +70738,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -65922,6 +70869,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65930,14 +70878,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65946,14 +70897,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65962,6 +70916,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -65976,9 +70931,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -65988,21 +70945,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", "type": "integer", "format": "int64", "readOnly": true }, "stock": { + "description": "Indicates the number of products available.", "type": "integer", "format": "int64" }, @@ -66013,6 +70975,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -66023,32 +70986,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -66058,29 +71029,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -66139,20 +71117,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -66187,6 +71160,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -66452,6 +71437,37 @@ } }, "type": "object" + }, + "employeeWishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "e91afc4e24376c8b995cece3ce354b4e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -66459,6 +71475,7 @@ "relationships": { "properties": { "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -66490,6 +71507,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -66519,6 +71537,7 @@ "type": "object" }, "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -66550,6 +71569,7 @@ "type": "object" }, "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -66579,6 +71599,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -66608,6 +71629,7 @@ "type": "object" }, "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -66637,6 +71659,7 @@ "type": "object" }, "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -66666,6 +71689,7 @@ "type": "object" }, "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -66724,6 +71748,7 @@ "type": "object" }, "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -66753,6 +71778,7 @@ "type": "object" }, "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -66813,6 +71839,7 @@ "type": "object" }, "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -66844,6 +71871,7 @@ "type": "object" }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -66906,6 +71934,7 @@ "type": "object" }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -66999,6 +72028,7 @@ "type": "object" }, "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -67030,6 +72060,7 @@ "type": "object" }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -67061,6 +72092,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -67154,6 +72186,7 @@ "type": "object" }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -67185,6 +72218,7 @@ "type": "object" }, "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -67216,6 +72250,7 @@ "type": "object" }, "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -67247,6 +72282,7 @@ "type": "object" }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -67278,6 +72314,7 @@ "type": "object" }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -67309,6 +72346,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -67406,6 +72444,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -67414,14 +72453,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -67430,14 +72472,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -67446,6 +72491,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -67460,9 +72506,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -67472,21 +72520,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", "type": "integer", "format": "int64", "readOnly": true }, "stock": { + "description": "Indicates the number of products available.", "type": "integer", "format": "int64" }, @@ -67497,6 +72550,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -67507,32 +72561,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -67542,29 +72604,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -67623,20 +72692,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -67671,6 +72735,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -67936,48 +73012,89 @@ } }, "type": "object" + }, + "employeeWishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "e91afc4e24376c8b995cece3ce354b4e" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { + "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, "unit": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", @@ -67986,12 +73103,14 @@ } }, "media": { + "description": "Product images and media gallery", "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -68004,6 +73123,7 @@ } }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -68022,18 +73142,21 @@ } }, "productReviews": { + "description": "Customer reviews and ratings for the product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -68052,36 +73175,42 @@ } }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "properties": { + "description": "Product properties and characteristics for filtering", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "categories": { + "description": "Categories this product is assigned to", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "tags": { + "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -68190,6 +73319,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68198,10 +73328,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68209,6 +73341,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -68339,6 +73472,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68347,10 +73481,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68358,6 +73494,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -68407,26 +73544,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68435,6 +73579,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68566,26 +73711,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68594,6 +73746,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68643,10 +73796,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68655,6 +73810,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -68749,10 +73905,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68761,6 +73919,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -68837,6 +73996,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68845,10 +74005,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -68950,6 +74112,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68958,10 +74121,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -69014,64 +74179,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -69261,64 +74444,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -69488,13 +74689,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -69549,13 +74753,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "language": { @@ -69585,6 +74792,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69707,6 +74915,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69777,6 +74986,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69785,10 +74995,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -69921,6 +75133,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69929,10 +75142,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -70020,6 +75235,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70028,6 +75244,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70038,10 +75255,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -70145,6 +75364,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70153,6 +75373,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70163,10 +75384,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -70245,6 +75468,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70253,37 +75477,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -70441,6 +75675,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70449,37 +75684,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -70693,13 +75938,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -70801,13 +76049,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -70857,23 +76108,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -70968,23 +76225,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -71031,10 +76294,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71043,9 +76308,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -71146,10 +76413,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71158,9 +76427,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -71311,6 +76582,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -71323,6 +76595,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -71486,6 +76762,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -71498,6 +76775,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -71556,6 +76837,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71564,21 +76846,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -71627,6 +76914,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -71707,6 +76995,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71715,21 +77004,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -71750,7 +77044,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -71844,6 +77139,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71852,10 +77148,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { + "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64" }, @@ -71951,6 +77249,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -71959,10 +77258,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { + "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64" }, @@ -72201,53 +77502,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -72619,53 +77935,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -72838,36 +78169,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -72996,36 +78337,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -73075,14 +78426,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -73178,14 +78532,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -73254,10 +78611,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -73325,10 +78684,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -73453,14 +78814,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -73556,14 +78920,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -73606,16 +78973,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -73714,16 +79085,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -73800,15 +79175,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -73890,15 +79269,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -73948,6 +79331,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -73959,9 +79343,11 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -74159,6 +79545,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -74170,9 +79557,11 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -76799,7 +82188,8 @@ "type": "array", "items": { "type": "string" - } + }, + "deprecated": true }, "label": { "type": "string" @@ -77217,7 +82607,8 @@ "type": "array", "items": { "type": "string" - } + }, + "deprecated": true }, "label": { "type": "string" @@ -77688,16 +83079,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -78280,16 +83675,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -78520,13 +83919,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78538,6 +83940,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -78615,6 +84018,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -78695,13 +84099,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78713,6 +84120,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -78736,7 +84144,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -78802,38 +84211,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78842,10 +84260,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78854,6 +84274,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78862,10 +84283,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78876,24 +84299,30 @@ "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -78915,6 +84344,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -79109,6 +84539,37 @@ } }, "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -79300,6 +84761,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -79358,6 +84820,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -79387,6 +84850,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -79416,6 +84880,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -79445,6 +84910,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -79565,6 +85031,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -79627,6 +85094,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -79656,6 +85124,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -79685,6 +85154,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -80264,38 +85734,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80304,10 +85783,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80316,6 +85797,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80324,10 +85806,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80338,24 +85822,30 @@ "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -80377,6 +85867,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80571,6 +86062,37 @@ } }, "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -80609,22 +86131,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -80642,6 +86169,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -80654,13 +86182,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -80774,15 +86305,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -80835,9 +86374,14 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ - "id" + "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", + "createdAt" ], "properties": { "id": { @@ -80845,15 +86389,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Google Analytics tracking ID (e.g., UA-XXXXX-Y or G-XXXXXXXX)", "type": "string" }, "active": { + "description": "Whether Google Analytics tracking is enabled", "type": "boolean" }, "trackOrders": { + "description": "Track order completions in Google Analytics", "type": "boolean" }, "anonymizeIp": { + "description": "Anonymize visitor IP addresses for GDPR compliance", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "createdAt": { @@ -80862,7 +86414,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -80949,21 +86504,26 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80971,6 +86531,7 @@ "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -81188,21 +86749,26 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -81210,6 +86776,7 @@ "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -81350,9 +86917,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -81442,9 +87011,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -81509,6 +87080,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -81810,6 +87382,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -81986,27 +87559,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -82041,27 +87621,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -82098,15 +87685,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -82177,15 +87768,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -82229,33 +87824,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -82363,33 +87967,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -82440,19 +88053,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -82520,19 +88138,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -82579,9 +88202,11 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -82589,21 +88214,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -82758,6 +88388,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -82787,6 +88418,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -82816,6 +88448,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -82847,6 +88480,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -82876,6 +88510,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -83000,6 +88635,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -83085,9 +88721,11 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -83095,21 +88733,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -83262,21 +88905,26 @@ "type": "object" }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -83301,7 +88949,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" @@ -83326,26 +88975,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -83477,26 +89132,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -83579,16 +89240,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -83658,16 +89323,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -83708,12 +89377,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -83815,12 +89486,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -86013,6 +91686,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -86154,6 +91828,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -86222,32 +91897,40 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86437,32 +92120,40 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86517,12 +92208,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -87096,12 +92789,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -87423,17 +93118,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -87562,17 +93261,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -87713,6 +93416,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "initialOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -87768,6 +93479,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "subscriptionEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a4844d7989267e34103e44248b16cf6c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "salesChannel": { @@ -88181,6 +93926,35 @@ } }, "type": "object" + }, + "initialOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/initialOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5dd26f6705e75ee9dc0876dc5cdc739a" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -88297,6 +94071,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "initialOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -88352,6 +94134,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "subscriptionEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a4844d7989267e34103e44248b16cf6c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -88402,6 +94218,9 @@ }, "language": { "$ref": "#/components/schemas/Language" + }, + "initialOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -89030,7 +94849,8 @@ { "required": [ "id", - "name" + "name", + "delayed" ], "properties": { "id": { @@ -89049,6 +94869,10 @@ "cronInterval": { "type": "string" }, + "delayed": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -89170,7 +94994,8 @@ "SubscriptionInterval": { "required": [ "id", - "name" + "name", + "delayed" ], "properties": { "id": { @@ -89189,6 +95014,10 @@ "cronInterval": { "type": "string" }, + "delayed": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -89877,6 +95706,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -89888,6 +95718,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -89953,6 +95784,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -89964,6 +95796,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -90472,14 +96305,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -90612,14 +96447,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -90676,26 +96513,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -90797,26 +96640,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -90865,14 +96714,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -90898,10 +96750,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -91027,14 +96881,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -91060,10 +96917,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -91108,10 +96967,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -91186,10 +97047,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -91741,41 +97604,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -92496,41 +98370,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -92919,16 +98804,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -92998,16 +98887,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -93048,10 +98941,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -93119,10 +99014,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -93162,9 +99059,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -93230,9 +99129,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -93820,26 +99721,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -93849,13 +99757,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -93930,26 +99841,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -93959,13 +99877,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -94023,6 +99944,365 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + } + } + }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "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" + ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "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)", @@ -94140,11 +100420,24 @@ }, "includes": { "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", "type": "object", "additionalProperties": { "type": "array", @@ -94716,458 +101009,212 @@ "field" ] }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] - } - ] - }, "infoConfigResponse": { "type": "object", "properties": { "version": { "type": "string", - "description": "The Shopware version." + "description": "Shopware version." + }, + "shopId": { + "type": "string", + "description": "Unique shop identifier." }, "versionRevision": { "type": "string", - "description": "The Shopware version revision." + "description": "Shopware version revision (build hash/revision)." }, "adminWorker": { "type": "object", - "description": "Information about the admin worker.", + "description": "Admin worker feature flags and transport configuration.", "properties": { "enableAdminWorker": { "type": "boolean", - "description": "State of the admin worker." + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled." + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." }, "transports": { "type": "array", - "description": "Configured transports.", + "description": "Configured Symfony Messenger transports used by the admin workers.", "items": { "type": "string" } } - } + }, + "additionalProperties": false }, "bundles": { "type": "object", - "description": "Asset files of active extensions", + "description": "Active extension assets (plugins & apps) keyed by technical name.", "additionalProperties": { - "type": "object", - "properties": { - "css": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the css file." - } + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the js file." - } + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false } - } + ] } }, "settings": { "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", "properties": { "enableUrlFeature": { "type": "boolean", - "description": "State of the `urlFeature` setting." - } - } - } - } - }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "State of the URL upload feature." }, - "gross": { - "description": "", - "type": "number" + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." }, - "net": { - "description": "", - "type": "number" + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } }, - "gross": { - "description": "", - "type": "number" + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." }, - "net": { - "description": "", - "type": "number" + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] - }, - "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" + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." } }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } - } - } - }, - "CustomPricingPrice": { - "type": "object", - "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", - "required": [ - "quantityStart", - "price" - ], - "properties": { - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { - "type": "integer", - "format": "int64", - "minimum": 1 + "additionalProperties": false }, - "price": { + "inAppPurchases": { "type": "array", + "description": "In-app purchase meta data (structure may vary).", "items": { "type": "object", - "description": "This field should house all the normal facets of the `product_price`.`price` column", - "required": [ - "currencyId", - "gross", - "net", - "linked" - ], - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - }, - "listPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - }, - "regulationPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - } - } + "description": "Purchase entry.", + "additionalProperties": true } } - } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false }, "CustomPricingUpsertOperation": { "type": "object", @@ -95330,6 +101377,187 @@ } } } + }, + "CustomPricingPrice": { + "type": "object", + "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", + "required": [ + "quantityStart", + "price" + ], + "properties": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "price": { + "type": "array", + "items": { + "type": "object", + "description": "This field should house all the normal facets of the `product_price`.`price` column", + "required": [ + "currencyId", + "gross", + "net", + "linked" + ], + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + }, + "listPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + }, + "regulationPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + } + } + } + } + } + }, + "Options": { + "type": "object", + "properties": { + "mood": { + "type": "string", + "enum": [ + "positive", + "neutral" + ], + "description": "Tone/mood to guide summary generation (optional)." + }, + "productId": { + "type": "string", + "description": "Product UUID (hex) identifying the product to generate summaries for. This field is required." + }, + "salesChannelId": { + "type": "string", + "description": "Sales channel UUID (hex) used to scope generation and locale/context resolution. This field is required." + }, + "languageIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of language UUIDs (hex). Provided language IDs will be mapped to locale codes server-side; supply this OR `locales`." + }, + "locales": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of locale codes (e.g. `de-DE`, `en-GB`). Supply this OR `languageIds`. At least one of `languageIds` or `locales` must be present." + }, + "length": { + "type": "integer", + "description": "Desired length of the generated summary in number of characters (optional, default: 300)." + }, + "reviews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "content": { + "type": "string" + }, + "points": { + "type": "string" + } + }, + "required": [ + "title", + "content", + "points" + ], + "description": "Array of review objects containing title, content, and points (optional, if not provided, reviews will be fetched from product)." + } + } + }, + "required": [ + "productId", + "salesChannelId" + ], + "anyOf": [ + { + "required": [ + "languageIds" + ] + }, + { + "required": [ + "locales" + ] + } + ], + "additionalProperties": true, + "description": "Options object passed to Review Summary generation." + }, + "ReviewSummaryItem": { + "type": "object", + "properties": { + "languageId": { + "type": "string" + }, + "summary": { + "type": "string" + } + }, + "additionalProperties": true + }, + "ReviewSummaryByLanguage": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Generated summary for the language id" + }, + "description": "Map of languageId to generated summary string." } }, "responses": { @@ -95772,6 +102000,10 @@ "name": "B2b Business Partner", "description": "The endpoint for operations on B2b Business Partner" }, + { + "name": "B2b Components Advanced Product Catalogs", + "description": "The endpoint for operations on B2b Components Advanced Product Catalogs" + }, { "name": "B2b Components Approval Rule", "description": "The endpoint for operations on B2b Components Approval Rule" @@ -95780,6 +102012,18 @@ "name": "B2b Components Approval Rule App Script Condition", "description": "The endpoint for operations on B2b Components Approval Rule App Script Condition" }, + { + "name": "B2b Components Budget", + "description": "The endpoint for operations on B2b Components Budget" + }, + { + "name": "B2b Components Employee Wishlist", + "description": "The endpoint for operations on B2b Components Employee Wishlist" + }, + { + "name": "B2b Components Employee Wishlist Product", + "description": "The endpoint for operations on B2b Components Employee Wishlist Product" + }, { "name": "B2b Components Organization", "description": "The endpoint for operations on B2b Components Organization" @@ -95808,6 +102052,10 @@ "name": "B2b Components Shopping List Line Item", "description": "The endpoint for operations on B2b Components Shopping List Line Item" }, + { + "name": "B2b Components Subscription Employee", + "description": "The endpoint for operations on B2b Components Subscription Employee" + }, { "name": "B2b Employee", "description": "The endpoint for operations on B2b Employee" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index ea559c5..3883085 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -3,9 +3,6 @@ "/_action/create-employee", "/_action/custom-price", "/_action/invite-employee", - "/_action/media/external-link", - "/_action/media/upload", - "/_action/media/upload_by_url", "/_action/quote/{quoteId}/comment", "/_action/quote/{quoteId}/lineItem", "/_action/quote/{quoteId}/product/{productId}", @@ -13,7 +10,6 @@ "/_action/share-config/download/{entity}/{id}", "/_action/share-config/upload/{entity}", "/_action/text-to-image/generate", - "/_action/theme/{themeId}", "/_action/update-employee", "/_proxy-quote/{salesChannelId}", "/advanced-search-action", @@ -41,8 +37,12 @@ "/aggregate/advanced-search-entity-stream-filter", "/aggregate/advanced-search-synonym", "/aggregate/b2b-business-partner", + "/aggregate/b2b-components-advanced-product-catalogs", "/aggregate/b2b-components-approval-rule", "/aggregate/b2b-components-approval-rule-app-script-condition", + "/aggregate/b2b-components-budget", + "/aggregate/b2b-components-employee-wishlist", + "/aggregate/b2b-components-employee-wishlist-product", "/aggregate/b2b-components-organization", "/aggregate/b2b-components-organization-customer-address", "/aggregate/b2b-components-pending-order", @@ -50,13 +50,12 @@ "/aggregate/b2b-components-role", "/aggregate/b2b-components-shopping-list", "/aggregate/b2b-components-shopping-list-line-item", + "/aggregate/b2b-components-subscription-employee", "/aggregate/b2b-employee", "/aggregate/b2b-order-employee", "/aggregate/b2b-permission", "/aggregate/custom-price", "/aggregate/customer-specific-features", - "/aggregate/measurement-display-unit", - "/aggregate/measurement-system", "/aggregate/media-ai-tag", "/aggregate/order-product-warehouse", "/aggregate/order-return", @@ -91,16 +90,22 @@ "/aggregate/swag-delay-action", "/aggregate/warehouse", "/aggregate/warehouse-group", + "/api/_action/generate-review-summary", "/api/_admin/rule-builder-preview/{orderId}", - "/app-system/privileges/requested", - "/app-system/{appName}/privileges", - "/app-system/{appName}/privileges/accepted", "/b2b-business-partner", "/b2b-business-partner/{id}", + "/b2b-components-advanced-product-catalogs", + "/b2b-components-advanced-product-catalogs/{id}", "/b2b-components-approval-rule", "/b2b-components-approval-rule-app-script-condition", "/b2b-components-approval-rule-app-script-condition/{id}", "/b2b-components-approval-rule/{id}", + "/b2b-components-budget", + "/b2b-components-budget/{id}", + "/b2b-components-employee-wishlist", + "/b2b-components-employee-wishlist-product", + "/b2b-components-employee-wishlist-product/{id}", + "/b2b-components-employee-wishlist/{id}", "/b2b-components-organization", "/b2b-components-organization-customer-address", "/b2b-components-organization-customer-address/{id}", @@ -115,20 +120,21 @@ "/b2b-components-shopping-list-line-item", "/b2b-components-shopping-list-line-item/{id}", "/b2b-components-shopping-list/{id}", + "/b2b-components-subscription-employee", + "/b2b-components-subscription-employee/{id}", "/b2b-employee", "/b2b-employee/{id}", "/b2b-order-employee", "/b2b-order-employee/{id}", "/b2b-permission", "/b2b-permission/{id}", + "/consents", + "/consents/accept", + "/consents/revoke", "/custom-price", "/custom-price/{id}", "/customer-specific-features", "/customer-specific-features/{id}", - "/measurement-display-unit", - "/measurement-display-unit/{id}", - "/measurement-system", - "/measurement-system/{id}", "/media-ai-tag", "/media-ai-tag/{id}", "/order-product-warehouse", @@ -170,8 +176,12 @@ "/search/advanced-search-entity-stream-filter", "/search/advanced-search-synonym", "/search/b2b-business-partner", + "/search/b2b-components-advanced-product-catalogs", "/search/b2b-components-approval-rule", "/search/b2b-components-approval-rule-app-script-condition", + "/search/b2b-components-budget", + "/search/b2b-components-employee-wishlist", + "/search/b2b-components-employee-wishlist-product", "/search/b2b-components-organization", "/search/b2b-components-organization-customer-address", "/search/b2b-components-pending-order", @@ -179,13 +189,12 @@ "/search/b2b-components-role", "/search/b2b-components-shopping-list", "/search/b2b-components-shopping-list-line-item", + "/search/b2b-components-subscription-employee", "/search/b2b-employee", "/search/b2b-order-employee", "/search/b2b-permission", "/search/custom-price", "/search/customer-specific-features", - "/search/measurement-display-unit", - "/search/measurement-system", "/search/media-ai-tag", "/search/order-product-warehouse", "/search/order-return", @@ -307,10 +316,21 @@ "Associations", "B2bBusinessPartner", "B2bBusinessPartnerJsonApi", + "B2bComponentsAdvancedProductCatalogs", + "B2bComponentsAdvancedProductCatalogsCategory", + "B2bComponentsAdvancedProductCatalogsJsonApi", "B2bComponentsApprovalRule", "B2bComponentsApprovalRuleAppScriptCondition", "B2bComponentsApprovalRuleAppScriptConditionJsonApi", "B2bComponentsApprovalRuleJsonApi", + "B2bComponentsBudget", + "B2bComponentsBudgetJsonApi", + "B2bComponentsBudgetNotificationRecipient", + "B2bComponentsBudgetOrganization", + "B2bComponentsEmployeeWishlist", + "B2bComponentsEmployeeWishlistJsonApi", + "B2bComponentsEmployeeWishlistProduct", + "B2bComponentsEmployeeWishlistProductJsonApi", "B2bComponentsOrganization", "B2bComponentsOrganizationCustomerAddress", "B2bComponentsOrganizationCustomerAddressJsonApi", @@ -327,6 +347,8 @@ "B2bComponentsShoppingListJsonApi", "B2bComponentsShoppingListLineItem", "B2bComponentsShoppingListLineItemJsonApi", + "B2bComponentsSubscriptionEmployee", + "B2bComponentsSubscriptionEmployeeJsonApi", "B2bEmployee", "B2bEmployeeJsonApi", "B2bOrderEmployee", @@ -344,6 +366,7 @@ "CmsSectionJsonApi", "CmsSlot", "CmsSlotJsonApi", + "ConsentState", "Country", "CountryJsonApi", "CountryState", @@ -394,6 +417,7 @@ "DocumentType", "DocumentTypeJsonApi", "EqualsFilter", + "Excludes", "Filters", "Flow", "FlowJsonApi", @@ -470,6 +494,7 @@ "OAuthPasswordGrant", "OAuthRefreshTokenGrant", "OAuthScopes", + "Options", "Order", "OrderAddress", "OrderAddressJsonApi", @@ -597,6 +622,8 @@ "QuoteTransaction", "QuoteTransactionJsonApi", "RangeFilter", + "ReviewSummaryByLanguage", + "ReviewSummaryItem", "Rule", "RuleCondition", "RuleConditionJsonApi",