diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 905f06f..a7f01a9 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -16245,14 +16245,15 @@ } } }, - "/custom-price": { + "/bundle-discount": { "get": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "List with basic information of Custom Price resources.", - "description": "", - "operationId": "getCustomPriceList", + "summary": "List with basic information of Bundle Discount resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getBundleDiscountList", "parameters": [ { "name": "limit", @@ -16281,7 +16282,7 @@ ], "responses": { "200": { - "description": "List of Custom Price resources.", + "description": "List of Bundle Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16300,7 +16301,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } ] @@ -16314,16 +16315,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-price?limit=25" + "example": "/bundle-discount?limit=25" }, "last": { - "example": "/custom-price?limit=25&page=11" + "example": "/bundle-discount?limit=25&page=11" }, "next": { - "example": "/custom-price?limit=25&page=4" + "example": "/bundle-discount?limit=25&page=4" }, "prev": { - "example": "/custom-price?limit=25&page=2" + "example": "/bundle-discount?limit=25&page=2" } } } @@ -16344,7 +16345,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16359,11 +16360,12 @@ }, "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Create a new Custom Price resources.", - "description": "", - "operationId": "createCustomPrice", + "summary": "Create a new Bundle Discount resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createBundleDiscount", "parameters": [ { "name": "_response", @@ -16382,14 +16384,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16401,7 +16403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16416,7 +16418,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16432,14 +16434,15 @@ } } }, - "/search/custom-price": { + "/search/bundle-discount": { "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Search for the Custom Price resources.", - "description": "", - "operationId": "searchCustomPrice", + "summary": "Search for the Bundle Discount resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchBundleDiscount", "parameters": [ { "name": "sw-include-search-info", @@ -16467,7 +16470,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16481,7 +16484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16499,7 +16502,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16516,19 +16519,20 @@ } } }, - "/custom-price/{id}": { + "/bundle-discount/{id}": { "get": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Detailed information about a Custom Price resource.", - "description": "", - "operationId": "getCustomPrice", + "summary": "Detailed information about a Bundle Discount resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16538,7 +16542,7 @@ ], "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16550,7 +16554,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16565,7 +16569,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16582,16 +16586,17 @@ }, "delete": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Delete a Custom Price resource.", - "description": "", - "operationId": "deleteCustomPrice", + "summary": "Delete a Bundle Discount resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16622,16 +16627,17 @@ }, "patch": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Partially update information about a Custom Price resource.", - "description": "", - "operationId": "updateCustomPrice", + "summary": "Partially update information about a Bundle Discount resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -16649,18 +16655,18 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Price resource.", + "description": "Partially update information about a Bundle Discount resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16672,7 +16678,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16687,7 +16693,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16706,14 +16712,15 @@ } } }, - "/aggregate/custom-price": { + "/aggregate/bundle-discount": { "post": { "tags": [ - "Custom Price" + "Bundle Discount", + "Experimental" ], - "summary": "Aggregate for the Custom Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomPrice", + "summary": "Aggregate for the Bundle Discount resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateBundleDiscount", "requestBody": { "required": true, "content": { @@ -16737,7 +16744,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -16751,7 +16758,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16769,7 +16776,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -16786,14 +16793,15 @@ } } }, - "/customer-specific-features": { + "/bundle-item": { "get": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "List with basic information of Customer Specific Features resources.", - "description": "", - "operationId": "getCustomerSpecificFeaturesList", + "summary": "List with basic information of Bundle Item resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getBundleItemList", "parameters": [ { "name": "limit", @@ -16822,7 +16830,7 @@ ], "responses": { "200": { - "description": "List of Customer Specific Features resources.", + "description": "List of Bundle Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16841,7 +16849,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } ] @@ -16855,16 +16863,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-specific-features?limit=25" + "example": "/bundle-item?limit=25" }, "last": { - "example": "/customer-specific-features?limit=25&page=11" + "example": "/bundle-item?limit=25&page=11" }, "next": { - "example": "/customer-specific-features?limit=25&page=4" + "example": "/bundle-item?limit=25&page=4" }, "prev": { - "example": "/customer-specific-features?limit=25&page=2" + "example": "/bundle-item?limit=25&page=2" } } } @@ -16885,7 +16893,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16900,11 +16908,12 @@ }, "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Create a new Customer Specific Features resources.", - "description": "", - "operationId": "createCustomerSpecificFeatures", + "summary": "Create a new Bundle Item resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createBundleItem", "parameters": [ { "name": "_response", @@ -16923,14 +16932,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -16942,7 +16951,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16957,7 +16966,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -16973,14 +16982,15 @@ } } }, - "/search/customer-specific-features": { + "/search/bundle-item": { "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Search for the Customer Specific Features resources.", - "description": "", - "operationId": "searchCustomerSpecificFeatures", + "summary": "Search for the Bundle Item resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchBundleItem", "parameters": [ { "name": "sw-include-search-info", @@ -17008,7 +17018,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17022,7 +17032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17040,7 +17050,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17057,19 +17067,20 @@ } } }, - "/customer-specific-features/{id}": { + "/bundle-item/{id}": { "get": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Detailed information about a Customer Specific Features resource.", - "description": "", - "operationId": "getCustomerSpecificFeatures", + "summary": "Detailed information about a Bundle Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17079,7 +17090,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17091,7 +17102,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17106,7 +17117,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17123,16 +17134,17 @@ }, "delete": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Delete a Customer Specific Features resource.", - "description": "", - "operationId": "deleteCustomerSpecificFeatures", + "summary": "Delete a Bundle Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17163,16 +17175,17 @@ }, "patch": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Partially update information about a Customer Specific Features resource.", - "description": "", - "operationId": "updateCustomerSpecificFeatures", + "summary": "Partially update information about a Bundle Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -17190,18 +17203,18 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Specific Features resource.", + "description": "Partially update information about a Bundle Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17213,7 +17226,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17228,7 +17241,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17247,14 +17260,15 @@ } } }, - "/aggregate/customer-specific-features": { + "/aggregate/bundle-item": { "post": { "tags": [ - "Customer Specific Features" + "Bundle Item", + "Experimental" ], - "summary": "Aggregate for the Customer Specific Features resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerSpecificFeatures", + "summary": "Aggregate for the Bundle Item resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateBundleItem", "requestBody": { "required": true, "content": { @@ -17278,7 +17292,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -17292,7 +17306,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17310,7 +17324,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/BundleItem" } } } @@ -17327,14 +17341,14 @@ } } }, - "/media-ai-tag": { + "/custom-price": { "get": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "List with basic information of Media Ai Tag resources.", + "summary": "List with basic information of Custom Price resources.", "description": "", - "operationId": "getMediaAiTagList", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -17363,7 +17377,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17382,7 +17396,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -17396,16 +17410,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -17426,7 +17440,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17441,11 +17455,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Create a new Media Ai Tag resources.", + "summary": "Create a new Custom Price resources.", "description": "", - "operationId": "createMediaAiTag", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -17464,14 +17478,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17483,7 +17497,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17498,7 +17512,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17514,14 +17528,14 @@ } } }, - "/search/media-ai-tag": { + "/search/custom-price": { "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Search for the Media Ai Tag resources.", + "summary": "Search for the Custom Price resources.", "description": "", - "operationId": "searchMediaAiTag", + "operationId": "searchCustomPrice", "parameters": [ { "name": "sw-include-search-info", @@ -17549,7 +17563,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17563,7 +17577,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17581,7 +17595,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17598,19 +17612,19 @@ } } }, - "/media-ai-tag/{id}": { + "/custom-price/{id}": { "get": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Detailed information about a Media Ai Tag resource.", + "summary": "Detailed information about a Custom Price resource.", "description": "", - "operationId": "getMediaAiTag", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17620,7 +17634,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17632,7 +17646,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17647,7 +17661,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17664,16 +17678,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Delete a Media Ai Tag resource.", + "summary": "Delete a Custom Price resource.", "description": "", - "operationId": "deleteMediaAiTag", + "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17704,16 +17718,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Partially update information about a Media Ai Tag resource.", + "summary": "Partially update information about a Custom Price resource.", "description": "", - "operationId": "updateMediaAiTag", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -17731,18 +17745,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a Custom Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17754,7 +17768,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17769,7 +17783,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17788,14 +17802,14 @@ } } }, - "/aggregate/media-ai-tag": { + "/aggregate/custom-price": { "post": { "tags": [ - "Media Ai Tag" + "Custom Price" ], - "summary": "Aggregate for the Media Ai Tag resources.", + "summary": "Aggregate for the Custom Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaAiTag", + "operationId": "aggregateCustomPrice", "requestBody": { "required": true, "content": { @@ -17819,7 +17833,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -17833,7 +17847,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17851,7 +17865,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -17868,14 +17882,14 @@ } } }, - "/order-product-warehouse": { + "/customer-specific-features": { "get": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "List with basic information of Order Product Warehouse resources.", + "summary": "List with basic information of Customer Specific Features resources.", "description": "", - "operationId": "getOrderProductWarehouseList", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -17904,7 +17918,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17923,7 +17937,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -17937,16 +17951,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -17967,7 +17981,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -17982,11 +17996,11 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Create a new Order Product Warehouse resources.", + "summary": "Create a new Customer Specific Features resources.", "description": "", - "operationId": "createOrderProductWarehouse", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -18005,14 +18019,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18024,7 +18038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18039,7 +18053,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18055,14 +18069,14 @@ } } }, - "/search/order-product-warehouse": { + "/search/customer-specific-features": { "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Search for the Order Product Warehouse resources.", + "summary": "Search for the Customer Specific Features resources.", "description": "", - "operationId": "searchOrderProductWarehouse", + "operationId": "searchCustomerSpecificFeatures", "parameters": [ { "name": "sw-include-search-info", @@ -18090,7 +18104,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18104,7 +18118,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18122,7 +18136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18139,19 +18153,19 @@ } } }, - "/order-product-warehouse/{id}": { + "/customer-specific-features/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Detailed information about a Order Product Warehouse resource.", + "summary": "Detailed information about a Customer Specific Features resource.", "description": "", - "operationId": "getOrderProductWarehouse", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18161,7 +18175,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18173,7 +18187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18188,7 +18202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18205,16 +18219,16 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Delete a Order Product Warehouse resource.", + "summary": "Delete a Customer Specific Features resource.", "description": "", - "operationId": "deleteOrderProductWarehouse", + "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18245,16 +18259,16 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Partially update information about a Order Product Warehouse resource.", + "summary": "Partially update information about a Customer Specific Features resource.", "description": "", - "operationId": "updateOrderProductWarehouse", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -18272,18 +18286,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18295,7 +18309,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18310,7 +18324,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18329,14 +18343,14 @@ } } }, - "/aggregate/order-product-warehouse": { + "/aggregate/customer-specific-features": { "post": { "tags": [ - "Order Product Warehouse" + "Customer Specific Features" ], - "summary": "Aggregate for the Order Product Warehouse resources.", + "summary": "Aggregate for the Customer Specific Features resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderProductWarehouse", + "operationId": "aggregateCustomerSpecificFeatures", "requestBody": { "required": true, "content": { @@ -18360,7 +18374,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -18374,7 +18388,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18392,7 +18406,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -18409,14 +18423,14 @@ } } }, - "/order-return": { + "/media-ai-tag": { "get": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "List with basic information of Order Return resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getOrderReturnList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -18445,7 +18459,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18464,7 +18478,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -18478,16 +18492,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -18508,7 +18522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18523,11 +18537,11 @@ }, "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Create a new Order Return resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createOrderReturn", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -18546,14 +18560,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18565,7 +18579,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18580,7 +18594,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18596,14 +18610,14 @@ } } }, - "/search/order-return": { + "/search/media-ai-tag": { "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Search for the Order Return resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchOrderReturn", + "operationId": "searchMediaAiTag", "parameters": [ { "name": "sw-include-search-info", @@ -18631,7 +18645,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18645,7 +18659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18663,7 +18677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18680,19 +18694,19 @@ } } }, - "/order-return/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Detailed information about a Order Return resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getOrderReturn", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18702,7 +18716,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18714,7 +18728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18729,7 +18743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18746,16 +18760,16 @@ }, "delete": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Delete a Order Return resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteOrderReturn", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18786,16 +18800,16 @@ }, "patch": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Partially update information about a Order Return resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateOrderReturn", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -18813,18 +18827,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18836,7 +18850,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18851,7 +18865,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18870,14 +18884,14 @@ } } }, - "/aggregate/order-return": { + "/aggregate/media-ai-tag": { "post": { "tags": [ - "Order Return" + "Media Ai Tag" ], - "summary": "Aggregate for the Order Return resources.", + "summary": "Aggregate for the Media Ai Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturn", + "operationId": "aggregateMediaAiTag", "requestBody": { "required": true, "content": { @@ -18901,7 +18915,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -18915,7 +18929,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18933,7 +18947,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -18950,14 +18964,14 @@ } } }, - "/order-return-line-item": { + "/order-product-warehouse": { "get": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "List with basic information of Order Return Line Item resources.", + "summary": "List with basic information of Order Product Warehouse resources.", "description": "", - "operationId": "getOrderReturnLineItemList", + "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", @@ -18986,7 +19000,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19005,7 +19019,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } ] @@ -19019,16 +19033,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/order-product-warehouse?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/order-product-warehouse?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/order-product-warehouse?limit=25&page=2" } } } @@ -19049,7 +19063,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19064,11 +19078,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Create a new Order Return Line Item resources.", + "summary": "Create a new Order Product Warehouse resources.", "description": "", - "operationId": "createOrderReturnLineItem", + "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", @@ -19087,14 +19101,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19106,7 +19120,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19121,7 +19135,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19137,14 +19151,14 @@ } } }, - "/search/order-return-line-item": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Search for the Order Return Line Item resources.", + "summary": "Search for the Order Product Warehouse resources.", "description": "", - "operationId": "searchOrderReturnLineItem", + "operationId": "searchOrderProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -19172,7 +19186,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19186,7 +19200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19204,7 +19218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19221,19 +19235,19 @@ } } }, - "/order-return-line-item/{id}": { + "/order-product-warehouse/{id}": { "get": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Detailed information about a Order Return Line Item resource.", + "summary": "Detailed information about a Order Product Warehouse resource.", "description": "", - "operationId": "getOrderReturnLineItem", + "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19243,7 +19257,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19255,7 +19269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19270,7 +19284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19287,16 +19301,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Delete a Order Return Line Item resource.", + "summary": "Delete a Order Product Warehouse resource.", "description": "", - "operationId": "deleteOrderReturnLineItem", + "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19327,16 +19341,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Partially update information about a Order Return Line Item resource.", + "summary": "Partially update information about a Order Product Warehouse resource.", "description": "", - "operationId": "updateOrderReturnLineItem", + "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19354,18 +19368,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19377,7 +19391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19392,7 +19406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19411,14 +19425,14 @@ } } }, - "/aggregate/order-return-line-item": { + "/aggregate/order-product-warehouse": { "post": { "tags": [ - "Order Return Line Item" + "Order Product Warehouse" ], - "summary": "Aggregate for the Order Return Line Item resources.", + "summary": "Aggregate for the Order Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItem", + "operationId": "aggregateOrderProductWarehouse", "requestBody": { "required": true, "content": { @@ -19442,7 +19456,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19456,7 +19470,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19474,7 +19488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19491,14 +19505,14 @@ } } }, - "/order-return-line-item-reason": { + "/order-return": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", + "summary": "List with basic information of Order Return resources.", "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", @@ -19527,7 +19541,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19546,7 +19560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } ] @@ -19560,16 +19574,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/order-return?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/order-return?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/order-return?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/order-return?limit=25&page=2" } } } @@ -19590,7 +19604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19605,11 +19619,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Create a new Order Return Line Item Reason resources.", + "summary": "Create a new Order Return resources.", "description": "", - "operationId": "createOrderReturnLineItemReason", + "operationId": "createOrderReturn", "parameters": [ { "name": "_response", @@ -19628,14 +19642,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19647,7 +19661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19662,7 +19676,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19678,14 +19692,14 @@ } } }, - "/search/order-return-line-item-reason": { + "/search/order-return": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Search for the Order Return Line Item Reason resources.", + "summary": "Search for the Order Return resources.", "description": "", - "operationId": "searchOrderReturnLineItemReason", + "operationId": "searchOrderReturn", "parameters": [ { "name": "sw-include-search-info", @@ -19713,7 +19727,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19727,7 +19741,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19745,7 +19759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19762,19 +19776,19 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/order-return/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", + "summary": "Detailed information about a Order Return resource.", "description": "", - "operationId": "getOrderReturnLineItemReason", + "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19784,7 +19798,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19796,7 +19810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19811,7 +19825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19828,16 +19842,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Delete a Order Return Line Item Reason resource.", + "summary": "Delete a Order Return resource.", "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19868,16 +19882,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", + "summary": "Partially update information about a Order Return resource.", "description": "", - "operationId": "updateOrderReturnLineItemReason", + "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -19895,18 +19909,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a Order Return resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19918,7 +19932,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19933,7 +19947,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -19952,14 +19966,14 @@ } } }, - "/aggregate/order-return-line-item-reason": { + "/aggregate/order-return": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return" ], - "summary": "Aggregate for the Order Return Line Item Reason resources.", + "summary": "Aggregate for the Order Return resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItemReason", + "operationId": "aggregateOrderReturn", "requestBody": { "required": true, "content": { @@ -19983,7 +19997,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -19997,7 +20011,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20015,7 +20029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20032,14 +20046,14 @@ } } }, - "/order-warehouse-group": { + "/order-return-line-item": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of Order Return Line Item resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -20068,7 +20082,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20087,7 +20101,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -20101,16 +20115,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -20131,7 +20145,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20146,11 +20160,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new Order Return Line Item resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -20169,14 +20183,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20188,7 +20202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20203,7 +20217,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20219,14 +20233,14 @@ } } }, - "/search/order-warehouse-group": { + "/search/order-return-line-item": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Search for the Order Warehouse Group resources.", + "summary": "Search for the Order Return Line Item resources.", "description": "", - "operationId": "searchOrderWarehouseGroup", + "operationId": "searchOrderReturnLineItem", "parameters": [ { "name": "sw-include-search-info", @@ -20254,7 +20268,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20268,7 +20282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20286,7 +20300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20303,19 +20317,19 @@ } } }, - "/order-warehouse-group/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a Order Return Line Item resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20325,7 +20339,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20337,7 +20351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20352,7 +20366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20369,16 +20383,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a Order Return Line Item resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20409,16 +20423,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a Order Return Line Item resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20436,18 +20450,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20459,7 +20473,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20474,7 +20488,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20493,14 +20507,14 @@ } } }, - "/aggregate/order-warehouse-group": { + "/aggregate/order-return-line-item": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item" ], - "summary": "Aggregate for the Order Warehouse Group resources.", + "summary": "Aggregate for the Order Return Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderWarehouseGroup", + "operationId": "aggregateOrderReturnLineItem", "requestBody": { "required": true, "content": { @@ -20524,7 +20538,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20538,7 +20552,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20556,7 +20570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20573,14 +20587,14 @@ } } }, - "/product-review-summary": { + "/order-return-line-item-reason": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "List with basic information of Product Review Summary resources.", + "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", - "operationId": "getProductReviewSummaryList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -20609,7 +20623,7 @@ ], "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20628,7 +20642,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -20642,16 +20656,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review-summary?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/product-review-summary?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/product-review-summary?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/product-review-summary?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -20672,7 +20686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20687,11 +20701,11 @@ }, "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Create a new Product Review Summary resources.", + "summary": "Create a new Order Return Line Item Reason resources.", "description": "", - "operationId": "createProductReviewSummary", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -20710,14 +20724,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20729,7 +20743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20744,7 +20758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20760,14 +20774,14 @@ } } }, - "/search/product-review-summary": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Search for the Product Review Summary resources.", + "summary": "Search for the Order Return Line Item Reason resources.", "description": "", - "operationId": "searchProductReviewSummary", + "operationId": "searchOrderReturnLineItemReason", "parameters": [ { "name": "sw-include-search-info", @@ -20795,7 +20809,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20809,7 +20823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20827,7 +20841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20844,19 +20858,19 @@ } } }, - "/product-review-summary/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Detailed information about a Product Review Summary resource.", + "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "getProductReviewSummary", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20866,7 +20880,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -20878,7 +20892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20893,7 +20907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -20910,16 +20924,16 @@ }, "delete": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Delete a Product Review Summary resource.", + "summary": "Delete a Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteProductReviewSummary", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20950,16 +20964,16 @@ }, "patch": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Partially update information about a Product Review Summary resource.", + "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "updateProductReviewSummary", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -20977,18 +20991,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21000,7 +21014,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21015,7 +21029,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21034,14 +21048,14 @@ } } }, - "/aggregate/product-review-summary": { + "/aggregate/order-return-line-item-reason": { "post": { "tags": [ - "Product Review Summary" + "Order Return Line Item Reason" ], - "summary": "Aggregate for the Product Review Summary resources.", + "summary": "Aggregate for the Order Return Line Item Reason resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReviewSummary", + "operationId": "aggregateOrderReturnLineItemReason", "requestBody": { "required": true, "content": { @@ -21065,7 +21079,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21079,7 +21093,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21097,7 +21111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21114,14 +21128,14 @@ } } }, - "/product-warehouse": { + "/order-warehouse-group": { "get": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "List with basic information of Product Warehouse resources.", + "summary": "List with basic information of Order Warehouse Group resources.", "description": "", - "operationId": "getProductWarehouseList", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -21150,7 +21164,7 @@ ], "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21169,7 +21183,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -21183,16 +21197,16 @@ "type": "object", "properties": { "first": { - "example": "/product-warehouse?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/product-warehouse?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/product-warehouse?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/product-warehouse?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -21213,7 +21227,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21228,11 +21242,11 @@ }, "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Create a new Product Warehouse resources.", + "summary": "Create a new Order Warehouse Group resources.", "description": "", - "operationId": "createProductWarehouse", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -21251,14 +21265,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21270,7 +21284,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21285,7 +21299,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21301,14 +21315,14 @@ } } }, - "/search/product-warehouse": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Search for the Product Warehouse resources.", + "summary": "Search for the Order Warehouse Group resources.", "description": "", - "operationId": "searchProductWarehouse", + "operationId": "searchOrderWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", @@ -21336,7 +21350,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21350,7 +21364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21368,7 +21382,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21385,19 +21399,19 @@ } } }, - "/product-warehouse/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Detailed information about a Product Warehouse resource.", + "summary": "Detailed information about a Order Warehouse Group resource.", "description": "", - "operationId": "getProductWarehouse", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21407,7 +21421,7 @@ ], "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21419,7 +21433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21434,7 +21448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21451,16 +21465,16 @@ }, "delete": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Delete a Product Warehouse resource.", + "summary": "Delete a Order Warehouse Group resource.", "description": "", - "operationId": "deleteProductWarehouse", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21491,16 +21505,16 @@ }, "patch": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Partially update information about a Product Warehouse resource.", + "summary": "Partially update information about a Order Warehouse Group resource.", "description": "", - "operationId": "updateProductWarehouse", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21518,18 +21532,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21541,7 +21555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21556,7 +21570,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21575,14 +21589,14 @@ } } }, - "/aggregate/product-warehouse": { + "/aggregate/order-warehouse-group": { "post": { "tags": [ - "Product Warehouse" + "Order Warehouse Group" ], - "summary": "Aggregate for the Product Warehouse resources.", + "summary": "Aggregate for the Order Warehouse Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductWarehouse", + "operationId": "aggregateOrderWarehouseGroup", "requestBody": { "required": true, "content": { @@ -21606,7 +21620,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21620,7 +21634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21638,7 +21652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21655,14 +21669,14 @@ } } }, - "/quote": { + "/product-review-summary": { "get": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of Product Review Summary resources.", + "description": "", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -21691,7 +21705,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21710,7 +21724,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -21724,16 +21738,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -21754,7 +21768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21769,11 +21783,11 @@ }, "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new Product Review Summary resources.", + "description": "", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -21792,14 +21806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21811,7 +21825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21826,7 +21840,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21842,14 +21856,14 @@ } } }, - "/search/quote": { + "/search/product-review-summary": { "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", + "summary": "Search for the Product Review Summary resources.", + "description": "", + "operationId": "searchProductReviewSummary", "parameters": [ { "name": "sw-include-search-info", @@ -21877,7 +21891,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21891,7 +21905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21909,7 +21923,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21926,19 +21940,19 @@ } } }, - "/quote/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a Product Review Summary resource.", + "description": "", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -21948,7 +21962,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -21960,7 +21974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21975,7 +21989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -21992,16 +22006,16 @@ }, "delete": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a Product Review Summary resource.", + "description": "", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22032,16 +22046,16 @@ }, "patch": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a Product Review Summary resource.", + "description": "", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22059,18 +22073,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22082,7 +22096,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22097,7 +22111,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22116,14 +22130,14 @@ } } }, - "/aggregate/quote": { + "/aggregate/product-review-summary": { "post": { "tags": [ - "Quote" + "Product Review Summary" ], - "summary": "Aggregate for the Quote resources.", + "summary": "Aggregate for the Product Review Summary resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuote", + "operationId": "aggregateProductReviewSummary", "requestBody": { "required": true, "content": { @@ -22147,7 +22161,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22161,7 +22175,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22179,7 +22193,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22196,14 +22210,14 @@ } } }, - "/quote-comment": { + "/product-warehouse": { "get": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "List with basic information of Quote Comment resources.", + "summary": "List with basic information of Product Warehouse resources.", "description": "", - "operationId": "getQuoteCommentList", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -22232,7 +22246,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22251,7 +22265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -22265,16 +22279,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -22295,7 +22309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22310,11 +22324,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Create a new Quote Comment resources.", + "summary": "Create a new Product Warehouse resources.", "description": "", - "operationId": "createQuoteComment", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -22333,14 +22347,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22352,7 +22366,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22367,7 +22381,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22383,14 +22397,14 @@ } } }, - "/search/quote-comment": { + "/search/product-warehouse": { "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Search for the Quote Comment resources.", + "summary": "Search for the Product Warehouse resources.", "description": "", - "operationId": "searchQuoteComment", + "operationId": "searchProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -22418,7 +22432,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22432,7 +22446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22450,7 +22464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22467,19 +22481,19 @@ } } }, - "/quote-comment/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Detailed information about a Quote Comment resource.", + "summary": "Detailed information about a Product Warehouse resource.", "description": "", - "operationId": "getQuoteComment", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22489,7 +22503,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22501,7 +22515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22516,7 +22530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22533,16 +22547,16 @@ }, "delete": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Delete a Quote Comment resource.", + "summary": "Delete a Product Warehouse resource.", "description": "", - "operationId": "deleteQuoteComment", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22573,16 +22587,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Partially update information about a Quote Comment resource.", + "summary": "Partially update information about a Product Warehouse resource.", "description": "", - "operationId": "updateQuoteComment", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -22600,18 +22614,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22623,7 +22637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22638,7 +22652,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22657,14 +22671,14 @@ } } }, - "/aggregate/quote-comment": { + "/aggregate/product-warehouse": { "post": { "tags": [ - "Quote Comment" + "Product Warehouse" ], - "summary": "Aggregate for the Quote Comment resources.", + "summary": "Aggregate for the Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteComment", + "operationId": "aggregateProductWarehouse", "requestBody": { "required": true, "content": { @@ -22688,7 +22702,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22702,7 +22716,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22720,7 +22734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22737,14 +22751,14 @@ } } }, - "/quote-delivery": { + "/quote": { "get": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "List with basic information of Quote Delivery resources.", + "summary": "List with basic information of Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -22773,7 +22787,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22792,7 +22806,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } ] @@ -22806,16 +22820,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -22836,7 +22850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22851,11 +22865,11 @@ }, "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Create a new Quote Delivery resources.", + "summary": "Create a new Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -22874,14 +22888,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -22893,7 +22907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22908,7 +22922,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22924,14 +22938,14 @@ } } }, - "/search/quote-delivery": { + "/search/quote": { "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Search for the Quote Delivery resources.", + "summary": "Search for the Quote resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", + "operationId": "searchQuote", "parameters": [ { "name": "sw-include-search-info", @@ -22959,7 +22973,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -22973,7 +22987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -22991,7 +23005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23008,19 +23022,19 @@ } } }, - "/quote-delivery/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Detailed information about a Quote Delivery resource.", + "summary": "Detailed information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23030,7 +23044,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23042,7 +23056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23057,7 +23071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23074,16 +23088,16 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Delete a Quote Delivery resource.", + "summary": "Delete a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23114,16 +23128,16 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Partially update information about a Quote Delivery resource.", + "summary": "Partially update information about a Quote resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23141,18 +23155,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Quote resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23164,7 +23178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23179,7 +23193,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23198,14 +23212,14 @@ } } }, - "/aggregate/quote-delivery": { + "/aggregate/quote": { "post": { "tags": [ - "Quote Delivery" + "Quote" ], - "summary": "Aggregate for the Quote Delivery resources.", + "summary": "Aggregate for the Quote resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDelivery", + "operationId": "aggregateQuote", "requestBody": { "required": true, "content": { @@ -23229,7 +23243,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23243,7 +23257,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23261,7 +23275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Quote" } } } @@ -23278,14 +23292,14 @@ } } }, - "/quote-delivery-position": { + "/quote-comment": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "List with basic information of Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "summary": "List with basic information of Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -23314,7 +23328,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23333,7 +23347,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -23347,16 +23361,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -23377,7 +23391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23392,11 +23406,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Create a new Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -23415,14 +23429,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23434,7 +23448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23449,7 +23463,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23465,14 +23479,14 @@ } } }, - "/search/quote-delivery-position": { + "/search/quote-comment": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Search for the Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", + "summary": "Search for the Quote Comment resources.", + "description": "", + "operationId": "searchQuoteComment", "parameters": [ { "name": "sw-include-search-info", @@ -23500,7 +23514,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23514,7 +23528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23532,7 +23546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23549,19 +23563,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Detailed information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23571,7 +23585,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23583,7 +23597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23598,7 +23612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23615,16 +23629,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Delete a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23655,16 +23669,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Partially update information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "summary": "Partially update information about a Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -23682,18 +23696,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23705,7 +23719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23720,7 +23734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23739,14 +23753,14 @@ } } }, - "/aggregate/quote-delivery-position": { + "/aggregate/quote-comment": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Comment" ], - "summary": "Aggregate for the Quote Delivery Position resources.", + "summary": "Aggregate for the Quote Comment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDeliveryPosition", + "operationId": "aggregateQuoteComment", "requestBody": { "required": true, "content": { @@ -23770,7 +23784,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23784,7 +23798,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23802,7 +23816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23819,14 +23833,14 @@ } } }, - "/quote-document": { + "/quote-delivery": { "get": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "List with basic information of Quote Document resources.", - "description": "", - "operationId": "getQuoteDocumentList", + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -23855,7 +23869,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23874,7 +23888,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -23888,16 +23902,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -23918,7 +23932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -23933,11 +23947,11 @@ }, "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Create a new Quote Document resources.", - "description": "", - "operationId": "createQuoteDocument", + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -23956,14 +23970,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -23975,7 +23989,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -23990,7 +24004,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24006,14 +24020,14 @@ } } }, - "/search/quote-document": { + "/search/quote-delivery": { "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Search for the Quote Document resources.", - "description": "", - "operationId": "searchQuoteDocument", + "summary": "Search for the Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDelivery", "parameters": [ { "name": "sw-include-search-info", @@ -24041,7 +24055,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24055,7 +24069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24073,7 +24087,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24090,19 +24104,19 @@ } } }, - "/quote-document/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Detailed information about a Quote Document resource.", - "description": "", - "operationId": "getQuoteDocument", + "summary": "Detailed information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24112,7 +24126,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24124,7 +24138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24139,7 +24153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24156,16 +24170,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Delete a Quote Document resource.", - "description": "", - "operationId": "deleteQuoteDocument", + "summary": "Delete a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24196,16 +24210,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Partially update information about a Quote Document resource.", - "description": "", - "operationId": "updateQuoteDocument", + "summary": "Partially update information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24223,18 +24237,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24246,7 +24260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24261,7 +24275,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24280,14 +24294,14 @@ } } }, - "/aggregate/quote-document": { + "/aggregate/quote-delivery": { "post": { "tags": [ - "Quote Document" + "Quote Delivery" ], - "summary": "Aggregate for the Quote Document resources.", + "summary": "Aggregate for the Quote Delivery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDocument", + "operationId": "aggregateQuoteDelivery", "requestBody": { "required": true, "content": { @@ -24311,7 +24325,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24325,7 +24339,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24343,7 +24357,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24360,14 +24374,14 @@ } } }, - "/quote-employee": { + "/quote-delivery-position": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "List with basic information of Quote Employee resources.", - "description": "", - "operationId": "getQuoteEmployeeList", + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", @@ -24396,7 +24410,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24415,7 +24429,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] @@ -24429,16 +24443,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/quote-delivery-position?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/quote-delivery-position?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/quote-delivery-position?limit=25&page=2" } } } @@ -24459,7 +24473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24474,11 +24488,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Create a new Quote Employee resources.", - "description": "", - "operationId": "createQuoteEmployee", + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", @@ -24497,14 +24511,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24516,7 +24530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24531,7 +24545,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24547,14 +24561,14 @@ } } }, - "/search/quote-employee": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Search for the Quote Employee resources.", - "description": "", - "operationId": "searchQuoteEmployee", + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", "parameters": [ { "name": "sw-include-search-info", @@ -24582,7 +24596,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24596,7 +24610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24614,7 +24628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24631,19 +24645,19 @@ } } }, - "/quote-employee/{id}": { + "/quote-delivery-position/{id}": { "get": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Detailed information about a Quote Employee resource.", - "description": "", - "operationId": "getQuoteEmployee", + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24653,7 +24667,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24665,7 +24679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24680,7 +24694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24697,16 +24711,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Delete a Quote Employee resource.", - "description": "", - "operationId": "deleteQuoteEmployee", + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24737,16 +24751,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Partially update information about a Quote Employee resource.", - "description": "", - "operationId": "updateQuoteEmployee", + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -24764,18 +24778,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24787,7 +24801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24802,7 +24816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24821,14 +24835,14 @@ } } }, - "/aggregate/quote-employee": { + "/aggregate/quote-delivery-position": { "post": { "tags": [ - "Quote Employee" + "Quote Delivery Position" ], - "summary": "Aggregate for the Quote Employee resources.", + "summary": "Aggregate for the Quote Delivery Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteEmployee", + "operationId": "aggregateQuoteDeliveryPosition", "requestBody": { "required": true, "content": { @@ -24852,7 +24866,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -24866,7 +24880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24884,7 +24898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -24901,14 +24915,14 @@ } } }, - "/quote-line-item": { + "/quote-document": { "get": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "List with basic information of Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", + "summary": "List with basic information of Quote Document resources.", + "description": "", + "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", @@ -24937,7 +24951,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24956,7 +24970,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } ] @@ -24970,16 +24984,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/quote-document?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/quote-document?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/quote-document?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/quote-document?limit=25&page=2" } } } @@ -25000,7 +25014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25015,11 +25029,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "summary": "Create a new Quote Document resources.", + "description": "", + "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", @@ -25038,14 +25052,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25057,7 +25071,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25072,7 +25086,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25088,14 +25102,14 @@ } } }, - "/search/quote-line-item": { + "/search/quote-document": { "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Search for the Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", + "summary": "Search for the Quote Document resources.", + "description": "", + "operationId": "searchQuoteDocument", "parameters": [ { "name": "sw-include-search-info", @@ -25123,7 +25137,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25137,7 +25151,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25155,7 +25169,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25172,19 +25186,19 @@ } } }, - "/quote-line-item/{id}": { + "/quote-document/{id}": { "get": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "summary": "Detailed information about a Quote Document resource.", + "description": "", + "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25194,7 +25208,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25206,7 +25220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25221,7 +25235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25238,16 +25252,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "summary": "Delete a Quote Document resource.", + "description": "", + "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25278,16 +25292,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Partially update information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", + "summary": "Partially update information about a Quote Document resource.", + "description": "", + "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25305,18 +25319,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Quote Document resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25328,7 +25342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25343,7 +25357,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25362,14 +25376,14 @@ } } }, - "/aggregate/quote-line-item": { + "/aggregate/quote-document": { "post": { "tags": [ - "Quote Line Item" + "Quote Document" ], - "summary": "Aggregate for the Quote Line Item resources.", + "summary": "Aggregate for the Quote Document resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteLineItem", + "operationId": "aggregateQuoteDocument", "requestBody": { "required": true, "content": { @@ -25393,7 +25407,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25407,7 +25421,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25425,7 +25439,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25442,14 +25456,14 @@ } } }, - "/quote-transaction": { + "/quote-employee": { "get": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "List with basic information of Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", @@ -25478,7 +25492,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25497,7 +25511,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } ] @@ -25511,16 +25525,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/quote-employee?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/quote-employee?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/quote-employee?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/quote-employee?limit=25&page=2" } } } @@ -25541,7 +25555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25556,11 +25570,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Create a new Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", @@ -25579,14 +25593,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25598,7 +25612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25613,7 +25627,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25629,14 +25643,14 @@ } } }, - "/search/quote-transaction": { + "/search/quote-employee": { "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Search for the Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", + "summary": "Search for the Quote Employee resources.", + "description": "", + "operationId": "searchQuoteEmployee", "parameters": [ { "name": "sw-include-search-info", @@ -25664,7 +25678,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25678,7 +25692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25696,7 +25710,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25713,19 +25727,19 @@ } } }, - "/quote-transaction/{id}": { + "/quote-employee/{id}": { "get": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Detailed information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25735,7 +25749,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25747,7 +25761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25762,7 +25776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25779,16 +25793,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Delete a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25819,16 +25833,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Partially update information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -25846,18 +25860,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Quote Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25869,7 +25883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25884,7 +25898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25903,14 +25917,14 @@ } } }, - "/aggregate/quote-transaction": { + "/aggregate/quote-employee": { "post": { "tags": [ - "Quote Transaction" + "Quote Employee" ], - "summary": "Aggregate for the Quote Transaction resources.", + "summary": "Aggregate for the Quote Employee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteTransaction", + "operationId": "aggregateQuoteEmployee", "requestBody": { "required": true, "content": { @@ -25934,7 +25948,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -25948,7 +25962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25966,7 +25980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -25983,15 +25997,14 @@ } } }, - "/spatial-render-config-size": { + "/quote-line-item": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "getSpatialRenderConfigSizeList", + "summary": "List with basic information of Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", @@ -26020,7 +26033,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26039,7 +26052,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -26053,16 +26066,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/quote-line-item?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/quote-line-item?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/quote-line-item?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/quote-line-item?limit=25&page=2" } } } @@ -26083,7 +26096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26098,12 +26111,11 @@ }, "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "createSpatialRenderConfigSize", + "summary": "Create a new Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", @@ -26122,14 +26134,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26141,7 +26153,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26156,7 +26168,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26172,15 +26184,14 @@ } } }, - "/search/spatial-render-config-size": { + "/search/quote-line-item": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "searchSpatialRenderConfigSize", + "summary": "Search for the Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteLineItem", "parameters": [ { "name": "sw-include-search-info", @@ -26208,7 +26219,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26222,7 +26233,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26240,7 +26251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26257,20 +26268,19 @@ } } }, - "/spatial-render-config-size/{id}": { + "/quote-line-item/{id}": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "getSpatialRenderConfigSize", + "summary": "Detailed information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26280,7 +26290,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26292,7 +26302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26307,7 +26317,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26324,17 +26334,16 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "deleteSpatialRenderConfigSize", + "summary": "Delete a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26365,17 +26374,16 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "updateSpatialRenderConfigSize", + "summary": "Partially update information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26393,18 +26401,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26416,7 +26424,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26431,7 +26439,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26450,15 +26458,14 @@ } } }, - "/aggregate/spatial-render-config-size": { + "/aggregate/quote-line-item": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "summary": "Aggregate for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Quote Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialRenderConfigSize", + "operationId": "aggregateQuoteLineItem", "requestBody": { "required": true, "content": { @@ -26482,7 +26489,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26496,7 +26503,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26514,7 +26521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26531,15 +26538,14 @@ } } }, - "/spatial-scene": { + "/quote-transaction": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "getSpatialSceneList", + "summary": "List with basic information of Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", @@ -26568,7 +26574,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26587,7 +26593,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -26601,16 +26607,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/quote-transaction?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/quote-transaction?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/quote-transaction?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/quote-transaction?limit=25&page=2" } } } @@ -26631,7 +26637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26646,12 +26652,11 @@ }, "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "createSpatialScene", + "summary": "Create a new Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", @@ -26670,14 +26675,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26689,7 +26694,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26704,7 +26709,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26720,15 +26725,14 @@ } } }, - "/search/spatial-scene": { + "/search/quote-transaction": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "searchSpatialScene", + "summary": "Search for the Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", "parameters": [ { "name": "sw-include-search-info", @@ -26756,7 +26760,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26770,7 +26774,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26788,7 +26792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26805,20 +26809,19 @@ } } }, - "/spatial-scene/{id}": { + "/quote-transaction/{id}": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "getSpatialScene", + "summary": "Detailed information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -26828,7 +26831,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26840,7 +26843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26855,7 +26858,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26872,17 +26875,16 @@ }, "delete": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "deleteSpatialScene", + "summary": "Delete a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -26913,17 +26915,16 @@ }, "patch": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "", - "operationId": "updateSpatialScene", + "summary": "Partially update information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -26941,18 +26942,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26964,7 +26965,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26979,7 +26980,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -26998,15 +26999,14 @@ } } }, - "/aggregate/spatial-scene": { + "/aggregate/quote-transaction": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "summary": "Aggregate for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Quote Transaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialScene", + "operationId": "aggregateQuoteTransaction", "requestBody": { "required": true, "content": { @@ -27030,7 +27030,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27044,7 +27044,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27062,7 +27062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27079,15 +27079,15 @@ } } }, - "/spatial-scene-camera": { + "/spatial-render-config-size": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "List with basic information of Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCameraList", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -27116,7 +27116,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27135,7 +27135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -27149,16 +27149,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -27179,7 +27179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27194,12 +27194,12 @@ }, "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Create a new Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneCamera", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -27218,14 +27218,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27237,7 +27237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27252,7 +27252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27268,15 +27268,15 @@ } } }, - "/search/spatial-scene-camera": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Search for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneCamera", + "operationId": "searchSpatialRenderConfigSize", "parameters": [ { "name": "sw-include-search-info", @@ -27304,7 +27304,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27318,7 +27318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27336,7 +27336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27353,20 +27353,20 @@ } } }, - "/spatial-scene-camera/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCamera", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27376,7 +27376,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27388,7 +27388,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27403,7 +27403,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27420,17 +27420,17 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Delete a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneCamera", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27461,17 +27461,17 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneCamera", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27489,18 +27489,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27512,7 +27512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27527,7 +27527,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27546,15 +27546,15 @@ } } }, - "/aggregate/spatial-scene-camera": { + "/aggregate/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial 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": "aggregateSpatialSceneCamera", + "operationId": "aggregateSpatialRenderConfigSize", "requestBody": { "required": true, "content": { @@ -27578,7 +27578,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27592,7 +27592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27610,7 +27610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27627,15 +27627,15 @@ } } }, - "/spatial-scene-group": { + "/spatial-scene": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "List with basic information of Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroupList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -27664,7 +27664,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Group resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27683,7 +27683,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -27697,16 +27697,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-group?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/spatial-scene-group?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/spatial-scene-group?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-group?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -27727,7 +27727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27742,12 +27742,12 @@ }, "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Create a new Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneGroup", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -27766,14 +27766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27785,7 +27785,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27800,7 +27800,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27816,15 +27816,15 @@ } } }, - "/search/spatial-scene-group": { + "/search/spatial-scene": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Search for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneGroup", + "operationId": "searchSpatialScene", "parameters": [ { "name": "sw-include-search-info", @@ -27852,7 +27852,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27866,7 +27866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27884,7 +27884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27901,20 +27901,20 @@ } } }, - "/spatial-scene-group/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroup", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -27924,7 +27924,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27936,7 +27936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27951,7 +27951,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27968,17 +27968,17 @@ }, "delete": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Delete a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneGroup", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28009,17 +28009,17 @@ }, "patch": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneGroup", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28037,18 +28037,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Group resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28060,7 +28060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28075,7 +28075,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28094,15 +28094,15 @@ } } }, - "/aggregate/spatial-scene-group": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene 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": "aggregateSpatialScene", "requestBody": { "required": true, "content": { @@ -28126,7 +28126,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28140,7 +28140,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28158,7 +28158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28175,15 +28175,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-scene-camera": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", @@ -28212,7 +28212,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28231,7 +28231,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -28245,16 +28245,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-scene-camera?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-scene-camera?limit=25&page=2" } } } @@ -28275,7 +28275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28290,12 +28290,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", @@ -28314,14 +28314,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28333,7 +28333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28348,7 +28348,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28364,15 +28364,15 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchSpatialSceneCamera", "parameters": [ { "name": "sw-include-search-info", @@ -28400,7 +28400,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28414,7 +28414,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28432,7 +28432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28449,20 +28449,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-scene-camera/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28472,7 +28472,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28484,7 +28484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28499,7 +28499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28516,17 +28516,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28557,17 +28557,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28585,18 +28585,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28608,7 +28608,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28623,7 +28623,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28642,15 +28642,15 @@ } } }, - "/aggregate/spatial-scene-light": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Camera", "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 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": "aggregateSpatialSceneLight", + "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -28674,7 +28674,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28688,7 +28688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28706,7 +28706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28723,15 +28723,15 @@ } } }, - "/spatial-scene-material": { + "/spatial-scene-group": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterialList", + "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", @@ -28760,7 +28760,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Material resources.", + "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28779,7 +28779,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } ] @@ -28793,16 +28793,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-material?limit=25" + "example": "/spatial-scene-group?limit=25" }, "last": { - "example": "/spatial-scene-material?limit=25&page=11" + "example": "/spatial-scene-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene-material?limit=25&page=4" + "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-material?limit=25&page=2" + "example": "/spatial-scene-group?limit=25&page=2" } } } @@ -28823,7 +28823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28838,12 +28838,12 @@ }, "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneMaterial", + "operationId": "createSpatialSceneGroup", "parameters": [ { "name": "_response", @@ -28862,14 +28862,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -28881,7 +28881,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28896,7 +28896,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28912,15 +28912,15 @@ } } }, - "/search/spatial-scene-material": { + "/search/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneMaterial", + "operationId": "searchSpatialSceneGroup", "parameters": [ { "name": "sw-include-search-info", @@ -28948,7 +28948,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -28962,7 +28962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28980,7 +28980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28997,20 +28997,20 @@ } } }, - "/spatial-scene-material/{id}": { + "/spatial-scene-group/{id}": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterial", + "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29020,7 +29020,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29032,7 +29032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29047,7 +29047,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29064,17 +29064,17 @@ }, "delete": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneMaterial", + "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29105,17 +29105,17 @@ }, "patch": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneMaterial", + "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29133,18 +29133,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Material resource.", + "description": "Partially update information about a Spatial Scene Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29156,7 +29156,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29171,7 +29171,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29190,15 +29190,15 @@ } } }, - "/aggregate/spatial-scene-material": { + "/aggregate/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Group", "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 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": "aggregateSpatialSceneMaterial", + "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { @@ -29222,7 +29222,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29236,7 +29236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29254,7 +29254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29271,15 +29271,15 @@ } } }, - "/spatial-scene-object": { + "/spatial-scene-light": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObjectList", + "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", @@ -29308,7 +29308,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29327,7 +29327,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -29341,16 +29341,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/spatial-scene-light?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/spatial-scene-light?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/spatial-scene-light?limit=25&page=2" } } } @@ -29371,7 +29371,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29386,12 +29386,12 @@ }, "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneObject", + "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", @@ -29410,14 +29410,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29429,7 +29429,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29444,7 +29444,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29460,15 +29460,15 @@ } } }, - "/search/spatial-scene-object": { + "/search/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneObject", + "operationId": "searchSpatialSceneLight", "parameters": [ { "name": "sw-include-search-info", @@ -29496,7 +29496,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29510,7 +29510,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29528,7 +29528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29545,20 +29545,20 @@ } } }, - "/spatial-scene-object/{id}": { + "/spatial-scene-light/{id}": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObject", + "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29568,7 +29568,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29580,7 +29580,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29595,7 +29595,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29612,17 +29612,17 @@ }, "delete": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneObject", + "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29653,17 +29653,17 @@ }, "patch": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneObject", + "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29681,18 +29681,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29704,7 +29704,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29719,7 +29719,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29738,15 +29738,15 @@ } } }, - "/aggregate/spatial-scene-object": { + "/aggregate/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Light", "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 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": "aggregateSpatialSceneObject", + "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -29770,7 +29770,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +29784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29802,7 +29802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29819,15 +29819,15 @@ } } }, - "/spatial-scene-primitive": { + "/spatial-scene-material": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitiveList", + "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", @@ -29856,7 +29856,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Primitive resources.", + "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29875,7 +29875,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] @@ -29889,16 +29889,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-primitive?limit=25" + "example": "/spatial-scene-material?limit=25" }, "last": { - "example": "/spatial-scene-primitive?limit=25&page=11" + "example": "/spatial-scene-material?limit=25&page=11" }, "next": { - "example": "/spatial-scene-primitive?limit=25&page=4" + "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-primitive?limit=25&page=2" + "example": "/spatial-scene-material?limit=25&page=2" } } } @@ -29919,7 +29919,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -29934,12 +29934,12 @@ }, "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScenePrimitive", + "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", @@ -29958,14 +29958,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -29977,7 +29977,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -29992,7 +29992,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30008,15 +30008,15 @@ } } }, - "/search/spatial-scene-primitive": { + "/search/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScenePrimitive", + "operationId": "searchSpatialSceneMaterial", "parameters": [ { "name": "sw-include-search-info", @@ -30044,7 +30044,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30058,7 +30058,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30076,7 +30076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30093,20 +30093,20 @@ } } }, - "/spatial-scene-primitive/{id}": { + "/spatial-scene-material/{id}": { "get": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitive", + "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30116,7 +30116,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30128,7 +30128,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30143,7 +30143,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30160,17 +30160,17 @@ }, "delete": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScenePrimitive", + "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30201,17 +30201,17 @@ }, "patch": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScenePrimitive", + "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30229,18 +30229,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Primitive resource.", + "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +30252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30267,7 +30267,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30286,15 +30286,15 @@ } } }, - "/aggregate/spatial-scene-primitive": { + "/aggregate/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Primitive", + "Spatial Scene Material", "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 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": "aggregateSpatialScenePrimitive", + "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { @@ -30318,7 +30318,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30332,7 +30332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30350,7 +30350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30367,15 +30367,15 @@ } } }, - "/sso-provider": { + "/spatial-scene-object": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -30404,7 +30404,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30423,7 +30423,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -30437,16 +30437,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -30467,7 +30467,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30482,12 +30482,12 @@ }, "post": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSsoProvider", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -30506,14 +30506,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30525,7 +30525,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30540,7 +30540,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30556,15 +30556,15 @@ } } }, - "/search/sso-provider": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSsoProvider", + "operationId": "searchSpatialSceneObject", "parameters": [ { "name": "sw-include-search-info", @@ -30592,7 +30592,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30606,7 +30606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30624,7 +30624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30641,20 +30641,20 @@ } } }, - "/sso-provider/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProvider", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30664,7 +30664,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30676,7 +30676,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30691,7 +30691,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30708,17 +30708,17 @@ }, "delete": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSsoProvider", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30749,17 +30749,17 @@ }, "patch": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSsoProvider", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30777,18 +30777,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30800,7 +30800,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30815,7 +30815,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30834,15 +30834,15 @@ } } }, - "/aggregate/sso-provider": { + "/aggregate/spatial-scene-object": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Object", "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 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": "aggregateSsoProvider", + "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -30866,7 +30866,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30880,7 +30880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30898,7 +30898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30915,15 +30915,15 @@ } } }, - "/sso-provider-customer": { + "/spatial-scene-primitive": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", @@ -30952,7 +30952,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30971,7 +30971,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] @@ -30985,16 +30985,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/spatial-scene-primitive?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/spatial-scene-primitive?limit=25&page=2" } } } @@ -31015,7 +31015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31030,12 +31030,12 @@ }, "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", @@ -31054,14 +31054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31073,7 +31073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31088,7 +31088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31104,15 +31104,15 @@ } } }, - "/search/sso-provider-customer": { + "/search/spatial-scene-primitive": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchSpatialScenePrimitive", "parameters": [ { "name": "sw-include-search-info", @@ -31140,7 +31140,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31154,7 +31154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31172,7 +31172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31189,20 +31189,20 @@ } } }, - "/sso-provider-customer/{id}": { + "/spatial-scene-primitive/{id}": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31212,7 +31212,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31224,7 +31224,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31239,7 +31239,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31256,17 +31256,17 @@ }, "delete": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31297,17 +31297,17 @@ }, "patch": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31325,18 +31325,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31348,7 +31348,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31363,7 +31363,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31382,15 +31382,15 @@ } } }, - "/aggregate/sso-provider-customer": { + "/aggregate/spatial-scene-primitive": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Primitive", "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 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": "aggregateSsoProviderCustomer", + "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { @@ -31414,7 +31414,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31428,7 +31428,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31446,7 +31446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31463,14 +31463,15 @@ } } }, - "/subscription": { + "/sso-provider": { "get": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "List with basic information of Subscription resources.", + "summary": "List with basic information of Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSubscriptionList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -31499,7 +31500,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31518,7 +31519,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -31532,16 +31533,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -31562,7 +31563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31577,11 +31578,12 @@ }, "post": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Create a new Subscription resources.", + "summary": "Create a new Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSubscription", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -31600,14 +31602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31619,7 +31621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31634,7 +31636,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31650,14 +31652,15 @@ } } }, - "/search/subscription": { + "/search/sso-provider": { "post": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Search for the Subscription resources.", + "summary": "Search for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSubscription", + "operationId": "searchSsoProvider", "parameters": [ { "name": "sw-include-search-info", @@ -31685,7 +31688,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31699,7 +31702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31717,7 +31720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31734,19 +31737,20 @@ } } }, - "/subscription/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Detailed information about a Subscription resource.", + "summary": "Detailed information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSubscription", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31756,7 +31760,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31768,7 +31772,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31783,7 +31787,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31800,16 +31804,17 @@ }, "delete": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Delete a Subscription resource.", + "summary": "Delete a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSubscription", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31840,16 +31845,17 @@ }, "patch": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Partially update information about a Subscription resource.", + "summary": "Partially update information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSubscription", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31867,18 +31873,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31890,7 +31896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31905,7 +31911,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31924,14 +31930,15 @@ } } }, - "/aggregate/subscription": { + "/aggregate/sso-provider": { "post": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Aggregate for the Subscription 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": "aggregateSubscription", + "operationId": "aggregateSsoProvider", "requestBody": { "required": true, "content": { @@ -31955,7 +31962,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31969,7 +31976,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31987,7 +31994,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32004,14 +32011,15 @@ } } }, - "/subscription-address": { + "/sso-provider-customer": { "get": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "List with basic information of Subscription Address resources.", + "summary": "List with basic information of Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSubscriptionAddressList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -32040,7 +32048,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32059,7 +32067,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -32073,16 +32081,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -32103,7 +32111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32118,11 +32126,12 @@ }, "post": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Create a new Subscription Address resources.", + "summary": "Create a new Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSubscriptionAddress", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -32141,14 +32150,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32160,7 +32169,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32175,7 +32184,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32191,14 +32200,15 @@ } } }, - "/search/subscription-address": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Search for the Subscription Address resources.", + "summary": "Search for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSubscriptionAddress", + "operationId": "searchSsoProviderCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -32226,7 +32236,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32240,7 +32250,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32258,7 +32268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32275,19 +32285,20 @@ } } }, - "/subscription-address/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Detailed information about a Subscription Address resource.", + "summary": "Detailed information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSubscriptionAddress", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32297,7 +32308,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32309,7 +32320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32324,7 +32335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32341,16 +32352,17 @@ }, "delete": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Delete a Subscription Address resource.", + "summary": "Delete a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSubscriptionAddress", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32381,16 +32393,17 @@ }, "patch": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Partially update information about a Subscription Address resource.", + "summary": "Partially update information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSubscriptionAddress", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32408,18 +32421,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32431,7 +32444,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32446,7 +32459,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32465,14 +32478,15 @@ } } }, - "/aggregate/subscription-address": { + "/aggregate/sso-provider-customer": { "post": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Aggregate for the Subscription Address 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": "aggregateSubscriptionAddress", + "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -32496,7 +32510,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32510,7 +32524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32528,7 +32542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32545,14 +32559,14 @@ } } }, - "/subscription-customer": { + "/subscription": { "get": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "List with basic information of Subscription Customer resources.", + "summary": "List with basic information of Subscription resources.", "description": "", - "operationId": "getSubscriptionCustomerList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -32581,7 +32595,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32600,7 +32614,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } ] @@ -32614,16 +32628,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -32644,7 +32658,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32659,11 +32673,11 @@ }, "post": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Create a new Subscription Customer resources.", + "summary": "Create a new Subscription resources.", "description": "", - "operationId": "createSubscriptionCustomer", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -32682,14 +32696,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32701,7 +32715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32716,7 +32730,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32732,14 +32746,14 @@ } } }, - "/search/subscription-customer": { + "/search/subscription": { "post": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Search for the Subscription Customer resources.", + "summary": "Search for the Subscription resources.", "description": "", - "operationId": "searchSubscriptionCustomer", + "operationId": "searchSubscription", "parameters": [ { "name": "sw-include-search-info", @@ -32767,7 +32781,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32781,7 +32795,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32799,7 +32813,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32816,19 +32830,19 @@ } } }, - "/subscription-customer/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Detailed information about a Subscription Customer resource.", + "summary": "Detailed information about a Subscription resource.", "description": "", - "operationId": "getSubscriptionCustomer", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32838,7 +32852,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32850,7 +32864,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32865,7 +32879,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32882,16 +32896,16 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Delete a Subscription Customer resource.", + "summary": "Delete a Subscription resource.", "description": "", - "operationId": "deleteSubscriptionCustomer", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32922,16 +32936,16 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Partially update information about a Subscription Customer resource.", + "summary": "Partially update information about a Subscription resource.", "description": "", - "operationId": "updateSubscriptionCustomer", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32949,18 +32963,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Subscription resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32972,7 +32986,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32987,7 +33001,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33006,14 +33020,14 @@ } } }, - "/aggregate/subscription-customer": { + "/aggregate/subscription": { "post": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Aggregate for the Subscription Customer resources.", + "summary": "Aggregate for the Subscription resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionCustomer", + "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { @@ -33037,7 +33051,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33051,7 +33065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33069,7 +33083,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33086,14 +33100,14 @@ } } }, - "/subscription-interval": { + "/subscription-address": { "get": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -33122,7 +33136,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33141,7 +33155,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -33155,16 +33169,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -33185,7 +33199,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33200,11 +33214,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -33223,14 +33237,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33242,7 +33256,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33257,7 +33271,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33273,14 +33287,14 @@ } } }, - "/search/subscription-interval": { + "/search/subscription-address": { "post": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchSubscriptionAddress", "parameters": [ { "name": "sw-include-search-info", @@ -33308,7 +33322,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33322,7 +33336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33340,7 +33354,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33357,19 +33371,19 @@ } } }, - "/subscription-interval/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33379,7 +33393,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33391,7 +33405,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33406,7 +33420,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33423,16 +33437,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33463,16 +33477,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33490,18 +33504,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Subscription Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33513,7 +33527,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33528,7 +33542,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33547,14 +33561,14 @@ } } }, - "/aggregate/subscription-interval": { + "/aggregate/subscription-address": { "post": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Aggregate for the Subscription Interval resources.", + "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionInterval", + "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -33578,7 +33592,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33592,7 +33606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33610,7 +33624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33627,14 +33641,14 @@ } } }, - "/subscription-plan": { + "/subscription-customer": { "get": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "List with basic information of Subscription Plan resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getSubscriptionPlanList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -33663,7 +33677,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33682,7 +33696,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -33696,16 +33710,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -33726,7 +33740,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33741,11 +33755,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Create a new Subscription Plan resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createSubscriptionPlan", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -33764,14 +33778,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33783,7 +33797,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33798,7 +33812,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33814,14 +33828,14 @@ } } }, - "/search/subscription-plan": { + "/search/subscription-customer": { "post": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Search for the Subscription Plan resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchSubscriptionPlan", + "operationId": "searchSubscriptionCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -33849,7 +33863,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33863,7 +33877,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33881,7 +33895,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33898,19 +33912,19 @@ } } }, - "/subscription-plan/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Detailed information about a Subscription Plan resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getSubscriptionPlan", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -33920,7 +33934,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33932,7 +33946,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33947,7 +33961,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33964,16 +33978,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Delete a Subscription Plan resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteSubscriptionPlan", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34004,16 +34018,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Partially update information about a Subscription Plan resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateSubscriptionPlan", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34031,18 +34045,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Subscription Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34054,7 +34068,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34069,7 +34083,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34088,14 +34102,14 @@ } } }, - "/aggregate/subscription-plan": { + "/aggregate/subscription-customer": { "post": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Aggregate for the Subscription Plan resources.", + "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionPlan", + "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -34119,7 +34133,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34133,7 +34147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34151,7 +34165,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34168,14 +34182,14 @@ } } }, - "/swag-delay-action": { + "/subscription-interval": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "List with basic information of Swag Delay Action resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getSwagDelayActionList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -34204,7 +34218,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34223,7 +34237,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -34237,16 +34251,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -34267,7 +34281,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34282,11 +34296,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Create a new Swag Delay Action resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createSwagDelayAction", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -34305,14 +34319,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34324,7 +34338,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34339,7 +34353,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34355,14 +34369,14 @@ } } }, - "/search/swag-delay-action": { + "/search/subscription-interval": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Search for the Swag Delay Action resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchSwagDelayAction", + "operationId": "searchSubscriptionInterval", "parameters": [ { "name": "sw-include-search-info", @@ -34390,7 +34404,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34404,7 +34418,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34422,7 +34436,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34439,19 +34453,19 @@ } } }, - "/swag-delay-action/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Detailed information about a Swag Delay Action resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getSwagDelayAction", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34461,7 +34475,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34473,7 +34487,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34488,7 +34502,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34505,16 +34519,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Delete a Swag Delay Action resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteSwagDelayAction", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34545,16 +34559,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Partially update information about a Swag Delay Action resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateSwagDelayAction", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34572,18 +34586,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Subscription Interval resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34595,7 +34609,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34610,7 +34624,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34629,14 +34643,14 @@ } } }, - "/aggregate/swag-delay-action": { + "/aggregate/subscription-interval": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Aggregate for the Swag Delay Action resources.", + "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagDelayAction", + "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -34660,7 +34674,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34674,7 +34688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34692,7 +34706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34709,14 +34723,14 @@ } } }, - "/warehouse": { + "/subscription-plan": { "get": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "List with basic information of Warehouse resources.", + "summary": "List with basic information of Subscription Plan resources.", "description": "", - "operationId": "getWarehouseList", + "operationId": "getSubscriptionPlanList", "parameters": [ { "name": "limit", @@ -34745,7 +34759,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34764,7 +34778,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } ] @@ -34778,16 +34792,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse?limit=25" + "example": "/subscription-plan?limit=25" }, "last": { - "example": "/warehouse?limit=25&page=11" + "example": "/subscription-plan?limit=25&page=11" }, "next": { - "example": "/warehouse?limit=25&page=4" + "example": "/subscription-plan?limit=25&page=4" }, "prev": { - "example": "/warehouse?limit=25&page=2" + "example": "/subscription-plan?limit=25&page=2" } } } @@ -34808,7 +34822,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34823,11 +34837,11 @@ }, "post": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Create a new Warehouse resources.", + "summary": "Create a new Subscription Plan resources.", "description": "", - "operationId": "createWarehouse", + "operationId": "createSubscriptionPlan", "parameters": [ { "name": "_response", @@ -34846,14 +34860,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34865,7 +34879,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34880,7 +34894,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34896,14 +34910,14 @@ } } }, - "/search/warehouse": { + "/search/subscription-plan": { "post": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Search for the Warehouse resources.", + "summary": "Search for the Subscription Plan resources.", "description": "", - "operationId": "searchWarehouse", + "operationId": "searchSubscriptionPlan", "parameters": [ { "name": "sw-include-search-info", @@ -34931,7 +34945,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34945,7 +34959,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34963,7 +34977,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34980,19 +34994,19 @@ } } }, - "/warehouse/{id}": { + "/subscription-plan/{id}": { "get": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Detailed information about a Warehouse resource.", + "summary": "Detailed information about a Subscription Plan resource.", "description": "", - "operationId": "getWarehouse", + "operationId": "getSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35002,7 +35016,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35014,7 +35028,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35029,7 +35043,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35046,16 +35060,16 @@ }, "delete": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Delete a Warehouse resource.", + "summary": "Delete a Subscription Plan resource.", "description": "", - "operationId": "deleteWarehouse", + "operationId": "deleteSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35086,16 +35100,16 @@ }, "patch": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Partially update information about a Warehouse resource.", + "summary": "Partially update information about a Subscription Plan resource.", "description": "", - "operationId": "updateWarehouse", + "operationId": "updateSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35113,18 +35127,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "description": "Partially update information about a Subscription Plan resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35136,7 +35150,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35151,7 +35165,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35170,14 +35184,14 @@ } } }, - "/aggregate/warehouse": { + "/aggregate/subscription-plan": { "post": { "tags": [ - "Warehouse" + "Subscription Plan" ], - "summary": "Aggregate for the Warehouse resources.", + "summary": "Aggregate for the Subscription Plan resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouse", + "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -35201,7 +35215,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35215,7 +35229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35233,7 +35247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35250,14 +35264,14 @@ } } }, - "/warehouse-group": { + "/swag-delay-action": { "get": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "List with basic information of Warehouse Group resources.", + "summary": "List with basic information of Swag Delay Action resources.", "description": "", - "operationId": "getWarehouseGroupList", + "operationId": "getSwagDelayActionList", "parameters": [ { "name": "limit", @@ -35286,7 +35300,7 @@ ], "responses": { "200": { - "description": "List of Warehouse Group resources.", + "description": "List of Swag Delay Action resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35305,7 +35319,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } ] @@ -35319,16 +35333,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse-group?limit=25" + "example": "/swag-delay-action?limit=25" }, "last": { - "example": "/warehouse-group?limit=25&page=11" + "example": "/swag-delay-action?limit=25&page=11" }, "next": { - "example": "/warehouse-group?limit=25&page=4" + "example": "/swag-delay-action?limit=25&page=4" }, "prev": { - "example": "/warehouse-group?limit=25&page=2" + "example": "/swag-delay-action?limit=25&page=2" } } } @@ -35349,7 +35363,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35364,11 +35378,11 @@ }, "post": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Create a new Warehouse Group resources.", + "summary": "Create a new Swag Delay Action resources.", "description": "", - "operationId": "createWarehouseGroup", + "operationId": "createSwagDelayAction", "parameters": [ { "name": "_response", @@ -35387,14 +35401,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35406,7 +35420,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35421,7 +35435,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35437,14 +35451,14 @@ } } }, - "/search/warehouse-group": { + "/search/swag-delay-action": { "post": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Search for the Warehouse Group resources.", + "summary": "Search for the Swag Delay Action resources.", "description": "", - "operationId": "searchWarehouseGroup", + "operationId": "searchSwagDelayAction", "parameters": [ { "name": "sw-include-search-info", @@ -35472,7 +35486,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35486,7 +35500,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35504,7 +35518,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35521,19 +35535,19 @@ } } }, - "/warehouse-group/{id}": { + "/swag-delay-action/{id}": { "get": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Detailed information about a Warehouse Group resource.", + "summary": "Detailed information about a Swag Delay Action resource.", "description": "", - "operationId": "getWarehouseGroup", + "operationId": "getSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35543,7 +35557,7 @@ ], "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35555,7 +35569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35570,7 +35584,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35587,16 +35601,16 @@ }, "delete": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Delete a Warehouse Group resource.", + "summary": "Delete a Swag Delay Action resource.", "description": "", - "operationId": "deleteWarehouseGroup", + "operationId": "deleteSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35627,16 +35641,16 @@ }, "patch": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Partially update information about a Warehouse Group resource.", + "summary": "Partially update information about a Swag Delay Action resource.", "description": "", - "operationId": "updateWarehouseGroup", + "operationId": "updateSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35654,18 +35668,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35677,7 +35691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35692,7 +35706,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35711,14 +35725,14 @@ } } }, - "/aggregate/warehouse-group": { + "/aggregate/swag-delay-action": { "post": { "tags": [ - "Warehouse Group" + "Swag Delay Action" ], - "summary": "Aggregate for the Warehouse Group resources.", + "summary": "Aggregate for the Swag Delay Action resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouseGroup", + "operationId": "aggregateSwagDelayAction", "requestBody": { "required": true, "content": { @@ -35742,7 +35756,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35756,7 +35770,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35774,7 +35788,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35791,625 +35805,754 @@ } } }, - "/_action/user/logout": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Logout the current user", - "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", - "operationId": "userLogout", - "responses": { - "204": { - "description": "Tokens have been revoked successfully." - }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." - }, - "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - }, - "/app-system/shop/verify": { + "/warehouse": { "get": { "tags": [ - "App System", - "Public" + "Warehouse" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", "parameters": [ { - "name": "runId", + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, + "description": "The page to be returned", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "token", + "name": "query", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { - "204": { - "description": "An empty response signalling successful verification." - }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_action/custom-price": { - "post": { - "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit custom prices", - "description": "An emulation of Sync API implementation", - "operationId": "customPriceImport", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "oneOf": [ + "200": { + "description": "List of Warehouse resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ { - "$ref": "#/components/schemas/CustomPricingUpsertOperation" + "$ref": "#/components/schemas/success" }, { - "$ref": "#/components/schemas/CustomPricingDeleteOperation" + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/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" + } + } + } + ] + } + } } ] } - } - } - } - }, - "responses": { - "200": { - "description": "Returns a JSON result containing information about the updated entities", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPricingResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/api/_admin/rule-builder-preview/{orderId}": { + }, "post": { "tags": [ - "Rule Preview" + "Warehouse" ], - "summary": "Preview results of a rule evaluating an order", - "description": "Evaluate the conditions of a rule based on a pre-selected order.", - "operationId": "rulePreview", + "summary": "Create a new Warehouse resources.", + "description": "", + "operationId": "createWarehouse", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order the preview should be generated for", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "conditions" - ], - "properties": { - "conditions": { - "description": "Array of nested rule condition payloads.", - "items": { - "type": "object" - }, - "type": "array" - }, - "dateTime": { - "description": "A date and time to be mocked in the preview evaluation.", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { - "description": "Returns the results of the evaluated rule conditions as an object.", + "description": "Detail of Warehouse", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "array", - "items": { - "properties": { - "match": { - "description": "Evaluation of the condition", - "type": "boolean" - }, - "name": { - "description": "The technical name of the condition", - "type": "string" - }, - "ruleReferenceId": { - "description": "The id of the corresponding rule_condition entity", - "type": "string" - } + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/api/_action/generate-review-summary": { + "/search/warehouse": { "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" + "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": { - "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" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Array of generated summaries", + "description": "List of Warehouse", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "oneOf": [ + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReviewSummaryItem" - } + "$ref": "#/components/schemas/success" }, { - "$ref": "#/components/schemas/ReviewSummaryByLanguage" + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } } ] - }, - "example": { - "2fbb5fe2e29a4d70aa5854ce7ce3e20b": "Review Summary of the product in the specified language." } - } - } - }, - "400": { - "description": "Bad request — validation or generation error (message returned as plain JSON string)", - "content": { + }, "application/json": { "schema": { - "type": "string" - }, - "example": "License missing or generation failed:
" - } - } - } - } - } - }, - "/_action/invite-employee": { - "post": { - "tags": [ - "B2B Employee Management" - ], - "summary": "Sends an invite email to employee", - "description": "This route is used to send an invite email to an employee", - "operationId": "inviteEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the employee to invite", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Id of the sales channel through which the registration will be fulfilled.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } } - }, - "required": [ - "id" - ], - "type": "object" + } } } - } - }, - "responses": { - "204": { - "description": "No content response" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/create-employee": { - "post": { + "/warehouse/{id}": { + "get": { "tags": [ - "B2B Employee Management" + "Warehouse" ], - "summary": "Creates an employee", - "description": "This route is used to create an employee", - "operationId": "createEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "firstName": { - "description": "First name of the new employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the new employee", - "type": "string" - }, - "email": { - "description": "Email of the new employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the new employee", - "type": "string" - } - }, - "type": "object" - } + "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": "IDs of the created employees", + "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": { - "description": "Array of the created employee ids", - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/Warehouse" } } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/update-employee": { - "patch": { + }, + "delete": { "tags": [ - "B2B Employee Management" + "Warehouse" ], - "summary": "Updates an employee", - "description": "This route is used to update an employee", - "operationId": "updateEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the employee", - "type": "string" - }, - "firstName": { - "description": "First name of the employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the employee", - "type": "string" - }, - "email": { - "description": "Email of the employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the employee", - "type": "string" - } - }, - "type": "object" - } + "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": { - "description": "No content response" + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_proxy-quote/{salesChannelId}": { - "post": { + }, + "patch": { "tags": [ - "B2B Quote Management" + "Warehouse" ], - "summary": "Create a new quote", - "description": "This route is used to create a new quote from admin", - "operationId": "createQuoteFromAdmin", + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", "parameters": [ { - "name": "salesChannelId", + "name": "id", "in": "path", - "description": "Identifier of the sales channel to be fetched", + "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": { - "required": false, + "description": "Partially update information about a Warehouse resource.", "content": { "application/json": { "schema": { - "properties": { - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "type": "object" + "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { - "description": "Quote entity", + "description": "Detail of Warehouse", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "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" } } } }, - "/_action/quote/{quoteId}/product/{productId}": { + "/aggregate/warehouse": { "post": { "tags": [ - "B2B Quote Management" - ], - "summary": "Add product to quote", - "description": "This route is used to add a product to a quote from admin", - "operationId": "addProductToQuote", - "parameters": [ - { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "productId", - "in": "path", - "description": "Identifier of the product to be fetched", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Warehouse" ], + "summary": "Aggregate for the Warehouse resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWarehouse", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "quantity": { - "type": "integer", - "pattern": "int32" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } } }, - "type": "object" + "required": [ + "aggregations" + ] } } } }, "responses": { - "204": { - "description": "No content response" + "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" } } } }, - "/_action/quote/{quoteId}/lineItem": { - "post": { + "/warehouse-group": { + "get": { "tags": [ - "B2B Quote Management" + "Warehouse Group" ], - "summary": "Add custom line item to quote", - "description": "This route is used to add a custom line item to a quote from admin", - "operationId": "addCustomLineItemToQuote", + "summary": "List with basic information of Warehouse Group resources.", + "description": "", + "operationId": "getWarehouseGroupList", "parameters": [ { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "identifier": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string", - "default": "custom" - }, - "quantity": { - "type": "integer", - "pattern": "int32" - }, - "label": { - "type": "string", - "default": "null" - }, - "description": { - "type": "string", - "default": "null" - }, - "removable": { - "type": "boolean", - "default": true - }, - "stackable": { - "type": "boolean", - "default": true - }, - "payload": { - "type": "array", - "items": { - "type": "object" + "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" + } + } + } + ] + } + } } - }, - "priceDefinition": { - "type": "array", - "items": { - "type": "object" + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } } } - }, - "type": "object" + } } } - } - }, - "responses": { - "204": { - "description": "No content response" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/quote/{quoteId}/recalculate": { + }, "post": { "tags": [ - "B2B Quote Management" + "Warehouse Group" ], - "summary": "Recalculate a quote", - "description": "This route is used to recalculate a quote", - "operationId": "recalculateQuote", + "summary": "Create a new Warehouse Group resources.", + "description": "", + "operationId": "createWarehouseGroup", "parameters": [ { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, "responses": { - "204": { - "description": "No content response" + "200": { + "description": "Detail of WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/quote/{quoteId}/comment": { + "/search/warehouse-group": { "post": { "tags": [ - "B2B Quote Management" + "Warehouse Group" ], - "summary": "Create a new comment", - "description": "This route is used to create a new comment from admin", - "operationId": "createComment", + "summary": "Search for the Warehouse Group resources.", + "description": "", + "operationId": "searchWarehouseGroup", "parameters": [ { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], @@ -36418,139 +36561,391 @@ "content": { "application/json": { "schema": { - "properties": { - "comment": { - "description": "Message content", - "type": "string" - }, - "state": { - "description": "Current quote state", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { - "204": { - "description": "No content response" - } - } - } - }, - "/_action/text-to-image/generate": { - "post": { - "tags": [ - "Text to Image" - ], - "summary": "Generate images based on a textual prompt", - "description": "Generate images based on a textual prompt", - "operationId": "textToImageGenerate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "description": "The textual prompt to describe what image to generate", - "type": "string", - "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" + "200": { + "description": "List of WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, + } + } + }, + "/warehouse-group/{id}": { + "get": { + "tags": [ + "Warehouse Group" + ], + "summary": "Detailed information about a Warehouse Group resource.", + "description": "", + "operationId": "getWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { - "description": "The base64 string representation of the generated image", + "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": "string", - "format": "byte", - "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/share-config/download/{entity}/{id}": { - "get": { + }, + "delete": { "tags": [ - "Admin API", - "Sharing", - "Download" + "Warehouse Group" ], - "summary": "Download a shared config", - "description": "This route is used to download a shared config", - "operationId": "downloadSharedConfig", + "summary": "Delete a Warehouse Group resource.", + "description": "", + "operationId": "deleteWarehouseGroup", "parameters": [ { - "name": "entity", + "name": "id", "in": "path", - "description": "Entity name of the shared config", + "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", - "enum": [ - "flow", - "rule" - ] + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Warehouse Group" + ], + "summary": "Partially update information about a Warehouse Group resource.", + "description": "", + "operationId": "updateWarehouseGroup", + "parameters": [ { "name": "id", "in": "path", - "description": "Id of the shared config", + "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } ], + "requestBody": { + "description": "Partially update information about a Warehouse Group resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, "responses": { "200": { - "description": "Download the shared config" + "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": { - "description": "Entity is not supported. Use flow, rule" + "$ref": "#/components/responses/400" }, "404": { - "description": "Entity with id is invalid or could not be found" + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/share-config/upload/{entity}": { + "/aggregate/warehouse-group": { "post": { "tags": [ - "Admin API", - "Sharing", - "Upload" + "Warehouse Group" ], - "summary": "Upload a shared config", - "description": "This route is used to upload a shared config", - "operationId": "uploadSharedConfig", + "summary": "Aggregate for the Warehouse Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWarehouseGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_action/custom-price": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit custom prices", + "description": "An emulation of Sync API implementation", + "operationId": "customPriceImport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomPricingUpsertOperation" + }, + { + "$ref": "#/components/schemas/CustomPricingDeleteOperation" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a JSON result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPricingResponse" + } + } + } + } + } + } + }, + "/api/_admin/rule-builder-preview/{orderId}": { + "post": { + "tags": [ + "Rule Preview" + ], + "summary": "Preview results of a rule evaluating an order", + "description": "Evaluate the conditions of a rule based on a pre-selected order.", + "operationId": "rulePreview", "parameters": [ { - "name": "entity", + "name": "orderId", "in": "path", - "description": "Entity name of the shared config", + "description": "Identifier of the order the preview should be generated for", "required": true, "schema": { "type": "string", - "enum": [ - "flow", - "rule" - ] + "pattern": "^[0-9a-f]{32}$" } } ], @@ -36559,1680 +36954,1534 @@ "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "conditions" + ], "properties": { - "data": { - "description": "Data of the shared config (Entities related that have to be included)", - "type": "object" - }, - "references": { - "description": "References of the shared config (ID's of entities that are referenced)", - "type": "object" - }, - "requirements": { - "description": "Requirements of the shared config (ID's of entities that are required)", - "type": "object" - }, - "flow": { - "description": "Flow of the shared config", - "type": "object" + "conditions": { + "description": "Array of nested rule condition payloads.", + "items": { + "type": "object" + }, + "type": "array" }, - "rule": { - "description": "Rule of the shared config", - "type": "object" + "dateTime": { + "description": "A date and time to be mocked in the preview evaluation.", + "type": "string" } }, - "required": [ - "data", - "references", - "requirements" - ] + "type": "object" } } } }, "responses": { "200": { - "description": "Upload the shared config" - }, - "400": { - "description": "Entity is not supported. Use flow, rule" + "description": "Returns the results of the evaluated rule conditions as an object.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "properties": { + "match": { + "description": "Evaluation of the condition", + "type": "boolean" + }, + "name": { + "description": "The technical name of the condition", + "type": "string" + }, + "ruleReferenceId": { + "description": "The id of the corresponding rule_condition entity", + "type": "string" + } + }, + "type": "object" + } + } + } + } } } } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" + }, + "/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" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" + "requestBody": { + "description": "Options for review summary generation.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Options" }, - { - "$ref": "#/components/schemas/pagination" + "example": { + "mood": "positive", + "productId": "019970d61cf071b481145788abdb2271", + "salesChannelId": "01988451220e7308bdda1b32e87db12f", + "languageIds": [ + "2fbb5fe2e29a4d70aa5854ce7ce3e20b" + ] } - ] - }, - "data": { - "$ref": "#/components/schemas/data" - }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + } } }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" + "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." + } + } + } }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "400": { + "description": "Bad request — validation or generation error (message returned as plain JSON string)", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": "License missing or generation failed:
" + } + } + } + } + } + }, + "/_action/invite-employee": { + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Sends an invite email to employee", + "description": "This route is used to send an invite email to an employee", + "operationId": "inviteEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee to invite", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Id of the sales channel through which the registration will be fulfilled.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "required": [ + "id" + ], + "type": "object" + } + } } }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "responses": { + "204": { + "description": "No content response" } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" + } + } + }, + "/_action/create-employee": { + "post": { + "tags": [ + "B2B Employee Management" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/attributes" - }, - "relationships": { - "$ref": "#/components/schemas/relationships" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "summary": "Creates an employee", + "description": "This route is used to create an employee", + "operationId": "createEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "firstName": { + "description": "First name of the new employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the new employee", + "type": "string" + }, + "email": { + "description": "Email of the new employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the new employee", + "type": "string" + } + }, + "type": "object" + } + } } }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + "responses": { + "200": { + "description": "IDs of the created employees", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Array of the created employee ids", + "type": "array", + "items": { + "type": "string" + } + } + } } - }, - { - "$ref": "#/components/schemas/link" } - ] - }, - "related": { - "$ref": "#/components/schemas/link" + } + } + } + } + }, + "/_action/update-employee": { + "patch": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Updates an employee", + "description": "This route is used to update an employee", + "operationId": "updateEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee", + "type": "string" + }, + "firstName": { + "description": "First name of the employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the employee", + "type": "string" + }, + "email": { + "description": "Email of the employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the employee", + "type": "string" + } + }, + "type": "object" + } + } } }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" + "responses": { + "204": { + "description": "No content response" + } } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, + } + }, + "/_proxy-quote/{salesChannelId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new quote", + "description": "This route is used to create a new quote from admin", + "operationId": "createQuoteFromAdmin", + "parameters": [ { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "type": "object" } } } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ - { - "required": [ - "data" - ] - }, + }, + "responses": { + "200": { + "description": "Quote entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "/_action/quote/{quoteId}/product/{productId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add product to quote", + "description": "This route is used to add a product to a quote from admin", + "operationId": "addProductToQuote", + "parameters": [ { - "required": [ - "meta" - ] + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "required": [ - "links" - ] - }, + "name": "productId", + "in": "path", + "description": "Identifier of the product to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "quantity": { + "type": "integer", + "pattern": "int32" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/lineItem": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add custom line item to quote", + "description": "This route is used to add a custom line item to a quote from admin", + "operationId": "addCustomLineItemToQuote", + "parameters": [ { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "identifier": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "$ref": "#/components/schemas/relationshipToMany" + "type": { + "type": "string", + "default": "custom" + }, + "quantity": { + "type": "integer", + "pattern": "int32" + }, + "label": { + "type": "string", + "default": "null" + }, + "description": { + "type": "string", + "default": "null" + }, + "removable": { + "type": "boolean", + "default": true + }, + "stackable": { + "type": "boolean", + "default": true + }, + "payload": { + "type": "array", + "items": { + "type": "object" + } + }, + "priceDefinition": { + "type": "array", + "items": { + "type": "object" + } } - ] + }, + "type": "object" } } } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/recalculate": { + "post": { + "tags": [ + "B2B Quote Management" ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ + "summary": "Recalculate a quote", + "description": "This route is used to recalculate a quote", + "operationId": "recalculateQuote", + "parameters": [ { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." - }, + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/comment": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new comment", + "description": "This route is used to create a new comment from admin", + "operationId": "createComment", + "parameters": [ { - "$ref": "#/components/schemas/linkage" + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { + "description": "Message content", + "type": "string" + }, + "state": { + "description": "Current quote state", + "type": "string" + } + }, + "type": "object" + } + } } }, - "type": "object", - "additionalProperties": false - }, - "pagination": { - "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" - }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" - }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" - }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" + "responses": { + "204": { + "description": "No content response" } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/meta" + } + } + }, + "/_action/text-to-image/generate": { + "post": { + "tags": [ + "Text to Image" + ], + "summary": "Generate images based on a textual prompt", + "description": "Generate images based on a textual prompt", + "operationId": "textToImageGenerate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "The textual prompt to describe what image to generate", + "type": "string", + "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" + } + } + } + } } }, - "type": "object", - "additionalProperties": false - }, - "error": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." - }, - "code": { - "type": "string", - "description": "An application-specific error code, expressed as a string value." - }, - "title": { - "type": "string", - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." - }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." - }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." - }, - "source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." - }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." + "responses": { + "200": { + "description": "The base64 string representation of the generated image", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "byte", + "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" + } } } - }, - "meta": { - "$ref": "#/components/schemas/meta" } - }, - "type": "object", - "additionalProperties": false - }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ + } + } + }, + "/_action/share-config/download/{entity}/{id}": { + "get": { + "tags": [ + "Admin API", + "Sharing", + "Download" + ], + "summary": "Download a shared config", + "description": "This route is used to download a shared config", + "operationId": "downloadSharedConfig", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "entity", + "in": "path", + "description": "Entity name of the shared config", + "required": true, + "schema": { + "type": "string", + "enum": [ + "flow", + "rule" + ] + } }, { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" - }, - "description": { - "description": "A short description of the ACL role.", - "type": "string" - }, - "privileges": { - "type": "array", - "items": { - "type": "string" - } - }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "users": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" - } - } - } - } - }, + "name": "id", + "in": "path", + "description": "Id of the shared config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Download the shared config" + }, + "400": { + "description": "Entity is not supported. Use flow, rule" + }, + "404": { + "description": "Entity with id is invalid or could not be found" + } + } + } + }, + "/_action/share-config/upload/{entity}": { + "post": { + "tags": [ + "Admin API", + "Sharing", + "Upload" + ], + "summary": "Upload a shared config", + "description": "This route is used to upload a shared config", + "operationId": "uploadSharedConfig", + "parameters": [ + { + "name": "entity", + "in": "path", + "description": "Entity name of the shared config", + "required": true, + "schema": { + "type": "string", + "enum": [ + "flow", + "rule" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Data of the shared config (Entities related that have to be included)", "type": "object" }, - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } - }, + "references": { + "description": "References of the shared config (ID's of entities that are referenced)", "type": "object" }, - "integrations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" - } - } - } - } - }, + "requirements": { + "description": "Requirements of the shared config (ID's of entities that are required)", + "type": "object" + }, + "flow": { + "description": "Flow of the shared config", + "type": "object" + }, + "rule": { + "description": "Rule of the shared config", "type": "object" } }, - "type": "object" + "required": [ + "data", + "references", + "requirements" + ] } + } + } + }, + "responses": { + "200": { + "description": "Upload the shared config" + }, + "400": { + "description": "Entity is not supported. Use flow, rule" + } + } + } + }, + "/product-bundle/search": { + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Product bundles search", + "operationId": "searchProductBundles", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" }, - "type": "object" + "description": "Set to 0 to suppress aggregations and search metadata." } - ] - }, - "AclRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" - }, - "description": { - "description": "A short description of the ACL role.", - "type": "string" - }, - "privileges": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } - }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" + } + }, + "responses": { + "200": { + "description": "Search response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + }, + "aggregations": { + "type": "object" + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + } + } + } } }, - "app": { - "$ref": "#/components/schemas/App" + "400": { + "$ref": "#/components/responses/400" }, - "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle/search-ids": { + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Search bundle identifiers", + "operationId": "searchProductBundleIds", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } }, - "type": "object" - }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "userId", - "aclRoleId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "responses": { + "200": { + "description": "ID search response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "400": { + "$ref": "#/components/responses/400" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle": { + "get": { + "tags": [ + "Product Bundles" + ], + "summary": "List bundles", + "operationId": "getProductBundles", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "name": "page", + "in": "query", + "schema": { + "type": "integer" + } }, - "user": { - "$ref": "#/components/schemas/User" + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + }, + "description": "SwagQL query" + } + ], + "responses": { + "200": { + "description": "Bundle list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + } + } + } + } }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" + } }, - "AdvancedSearchActionJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Create bundle(s)", + "operationId": "createProductBundles", + "parameters": [ { - "required": [ - "id", - "configId", - "type", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "active": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "name": { - "type": "string" - }, - "typeConfig": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the created bundle payload(s) instead of 204.", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProductWrite" + } + } + ] }, - "relationships": { - "properties": { - "searchTerms": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_action_search_term" - }, - "id": { - "type": "string", - "example": "952c07f523c564f09844ca7f880c2467" - } - } - } - } - }, - "type": "object" + "example": { + "name": "Starter kit", + "bundleItems": [ + { + "productId": "0190311a99bd4be3a456e9a72b4d1234", + "quantity": 1, + "min": 1, + "required": true }, - "config": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" - } - } + { + "productId": "0190311cef8a4c5d880b20a2bfe96543", + "quantity": 1, + "min": 1, + "required": true + } + ], + "visibilities": [ + { + "salesChannelId": "01902f89c8a94a629e102fa97d3a5678", + "visibility": 3 + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "Bundles created" + }, + "200": { + "description": "Created bundle payload(s) when _response is provided", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" } - }, - "type": "object" + } } - }, - "type": "object" + } } - }, - "type": "object" + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } }, - "AdvancedSearchAction": { - "required": [ - "id", - "configId", - "type", - "name" + "patch": { + "tags": [ + "Product Bundles" ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Update bundle(s)", + "operationId": "updateProductBundles", + "parameters": [ + { + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the updated bundle payload(s).", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProductWrite" + } + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "Bundles updated" }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "200": { + "description": "Updated bundle payload(s) when _response is provided", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + } + } + } }, - "validFrom": { - "type": "string", - "format": "date-time" + "400": { + "$ref": "#/components/responses/400" }, - "validTo": { + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle/{id}": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", - "format": "date-time" - }, - "active": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "name": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "get": { + "tags": [ + "Product Bundles" + ], + "summary": "Bundle detail", + "operationId": "getProductBundle", + "responses": { + "200": { + "description": "Bundle detail", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + } + } }, - "typeConfig": { - "type": "object" + "404": { + "$ref": "#/components/responses/404" + } + } + }, + "delete": { + "tags": [ + "Product Bundles" + ], + "summary": "Delete bundle", + "operationId": "deleteProductBundle", + "responses": { + "204": { + "description": "Bundle deleted" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "401": { + "$ref": "#/components/responses/401" }, - "updatedAt": { + "404": { + "$ref": "#/components/responses/404" + } + } + } + }, + "/product-bundle/{id}/clone": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "searchTerms": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Clone bundle", + "operationId": "cloneProductBundle", + "parameters": [ + { + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the cloned bundle payload instead of just the identifier.", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BundleProductWrite" + } } - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" } }, - "type": "object" - }, - "AdvancedSearchActionSearchTermJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "term", - "salesChannelId", - "actionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "term": { - "type": "string" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } + "responses": { + "200": { + "description": "Clone response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } }, - "type": "object" - }, - "action": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_action" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "418c5509e2171d55b0aee5c2ea4442b5" - } + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/BundleProduct" } } - }, - "type": "object" - } - }, - "type": "object" + } + ] + } } - }, - "type": "object" - } - ] - }, - "AdvancedSearchActionSearchTerm": { - "required": [ - "id", - "term", - "salesChannelId", - "actionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "term": { - "type": "string" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "400": { + "$ref": "#/components/responses/400" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "401": { + "$ref": "#/components/responses/401" }, - "action": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "404": { + "$ref": "#/components/responses/404" } - }, - "type": "object" - }, - "AdvancedSearchBoostingJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" + } + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - { - "required": [ - "id", - "boost", - "name", - "configId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "boost": { - "type": "number", - "format": "float" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" }, - "relationships": { - "properties": { - "productStream": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" - } - } - } - }, - "type": "object" - }, - "entityStream": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_entity_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" - } - } - } - }, - "type": "object" - }, - "config": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" - } - } - } - }, - "type": "object" - } - }, - "type": "object" + { + "$ref": "#/components/schemas/pagination" } + ] + }, + "data": { + "$ref": "#/components/schemas/data" + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" }, - "type": "object" + "uniqueItems": true } - ] + }, + "type": "object", + "additionalProperties": false }, - "AdvancedSearchBoosting": { + "failure": { "required": [ - "id", - "boost", - "name", - "configId" + "errors" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "boost": { - "type": "number", - "format": "float" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "meta": { + "$ref": "#/components/schemas/meta" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "links": { + "$ref": "#/components/schemas/links" }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "links": { + "$ref": "#/components/schemas/links" }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" } }, "type": "object" }, - "AdvancedSearchConfigJsonApi": { - "allOf": [ + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ { "$ref": "#/components/schemas/resource" }, { - "required": [ - "id", - "salesChannelId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "esEnabled": { - "type": "boolean" - }, - "andLogic": { - "type": "boolean" - }, - "minSearchLength": { - "type": "integer", - "format": "int64" - }, - "hitCount": { - "properties": { - "product": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "product_manufacturer": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "category": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "fields": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "d05b6ed7d2345020440df396d6da7f73" - } - } - } - } - }, - "type": "object" - }, - "boostings": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_boosting" - }, - "id": { - "type": "string", - "example": "8e571802e4ea39b214104ca60e13b5a6" - } - } - } - } - }, - "type": "object" - }, - "searchActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/searchActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_action" - }, - "id": { - "type": "string", - "example": "f7e07cbefd6755762faa802c35e48929" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" }, - "type": "object" + "uniqueItems": true } ] }, - "AdvancedSearchConfig": { + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", "required": [ - "id", - "salesChannelId" + "type", + "id" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "id": { + "type": "string" }, - "esEnabled": { - "type": "boolean" + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "andLogic": { - "type": "boolean" + "relationships": { + "$ref": "#/components/schemas/relationships" }, - "minSearchLength": { - "type": "integer", - "format": "int64" + "links": { + "$ref": "#/components/schemas/links" }, - "hitCount": { - "properties": { - "product": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "product_manufacturer": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" + } }, - "category": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" + { + "$ref": "#/components/schemas/link" } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - } - }, - "boostings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" - } + ] }, - "searchActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchAction" - } + "related": { + "$ref": "#/components/schemas/link" } }, - "type": "object" + "type": "object", + "additionalProperties": true }, - "AdvancedSearchConfigFieldJsonApi": { - "allOf": [ + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "$ref": "#/components/schemas/resource" + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { + "type": "object", "required": [ - "id", - "configId", - "entity", - "field" + "href" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" - }, - "ranking": { - "type": "integer", - "format": "int64" - }, - "createdAt": { + "href": { + "description": "A string containing the link's URL.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "uri-reference" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "meta": { + "$ref": "#/components/schemas/meta" + } + } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] + }, + { + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" }, - "relationships": { - "properties": { - "config": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" - } - } - } - }, - "type": "object" + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" }, - "customField": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ed2028a1c479c7e0065da597452d9c11" - } - } - } - }, - "type": "object" + { + "$ref": "#/components/schemas/relationshipToMany" } - }, - "type": "object" + ] } - }, - "type": "object" + } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, + { + "$ref": "#/components/schemas/linkage" } ] }, - "AdvancedSearchConfigField": { + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", "required": [ - "id", - "configId", - "entity", - "field" + "type", + "id" ], "properties": { + "type": { + "type": "string" + }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "uri-reference" }, - "customFieldId": { + "last": { + "description": "The last page of data", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "uri-reference" }, - "entity": { - "type": "string" + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" }, - "field": { + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" + } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { "type": "string" }, - "tokenize": { - "type": "boolean" + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "error": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for this particular occurrence of the problem." }, - "searchable": { - "type": "boolean" + "links": { + "$ref": "#/components/schemas/links" }, - "ranking": { - "type": "integer", - "format": "int64" + "status": { + "type": "string", + "description": "The HTTP status code applicable to this problem, expressed as a string value." }, - "createdAt": { + "code": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "An application-specific error code, expressed as a string value." }, - "updatedAt": { + "title": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." }, - "customField": { - "$ref": "#/components/schemas/CustomField" + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, - "AdvancedSearchEntityStreamJsonApi": { + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -38240,23 +38489,31 @@ { "required": [ "id", - "type" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "name": { + "description": "Name of the ACL role defined.", "type": "string" }, - "apiFilter": { - "type": "object", - "readOnly": true + "description": { + "description": "A short description of the ACL role.", + "type": "string" }, - "invalid": { - "type": "boolean", - "readOnly": true + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -38270,7 +38527,7 @@ }, "relationships": { "properties": { - "filters": { + "users": { "properties": { "links": { "type": "object", @@ -38278,7 +38535,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" } } }, @@ -38289,11 +38546,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "user" }, "id": { "type": "string", - "example": "2c9885d2b0c7e26971f60a90f33cf718" + "example": "9bc65c2abec141778ffaa729489f3e87" } } } @@ -38301,7 +38558,7 @@ }, "type": "object" }, - "boosting": { + "app": { "properties": { "links": { "type": "object", @@ -38309,7 +38566,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" } } }, @@ -38318,12 +38575,43 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_boosting" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ab105abdd48ced24ce7b0e516ca0970" + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "integrations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "example": "415320131958c70f4f250ca4d7e63bbd" + } } } } @@ -38338,26 +38626,35 @@ } ] }, - "AdvancedSearchEntityStream": { + "AclRole": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "type" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "name": { + "description": "Name of the ACL role defined.", "type": "string" }, - "apiFilter": { - "type": "object", - "readOnly": true + "description": { + "description": "A short description of the ACL role.", + "type": "string" }, - "invalid": { - "type": "boolean", - "readOnly": true + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -38369,19 +38666,63 @@ "format": "date-time", "readOnly": true }, - "filters": { + "users": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "$ref": "#/components/schemas/User" } }, - "boosting": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "app": { + "$ref": "#/components/schemas/App" + }, + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } } }, "type": "object" }, - "AdvancedSearchEntityStreamFilterJsonApi": { + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + } + }, + "type": "object" + }, + "AdvancedSearchActionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -38389,42 +38730,37 @@ { "required": [ "id", - "entityStreamId", - "type" + "configId", + "type", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "validFrom": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "type": { - "type": "string" + "validTo": { + "type": "string", + "format": "date-time" }, - "field": { - "type": "string" + "active": { + "type": "boolean" }, - "operator": { + "type": { "type": "string" }, - "value": { + "name": { "type": "string" }, - "parameters": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "customFields": { + "typeConfig": { "type": "object" }, "createdAt": { @@ -38439,7 +38775,7 @@ }, "relationships": { "properties": { - "entityStream": { + "searchTerms": { "properties": { "links": { "type": "object", @@ -38447,28 +38783,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_entity_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action_search_term" + }, + "id": { + "type": "string", + "example": "952c07f523c564f09844ca7f880c2467" + } } } } }, "type": "object" }, - "parent": { + "config": { "properties": { "links": { "type": "object", @@ -38476,7 +38814,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" } } }, @@ -38485,43 +38823,12 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "advanced_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "queries": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_entity_stream_filter" - }, - "id": { - "type": "string", - "example": "5da7eb4247add5dbd5776c9c0b38460a" - } + "example": "2245023265ae4cf87d02c8b6ba991139" } } } @@ -38536,45 +38843,40 @@ } ] }, - "AdvancedSearchEntityStreamFilter": { + "AdvancedSearchAction": { "required": [ "id", - "entityStreamId", - "type" + "configId", + "type", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "validFrom": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "type": { - "type": "string" + "validTo": { + "type": "string", + "format": "date-time" }, - "field": { - "type": "string" + "active": { + "type": "boolean" }, - "operator": { + "type": { "type": "string" }, - "value": { + "name": { "type": "string" }, - "parameters": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "customFields": { + "typeConfig": { "type": "object" }, "createdAt": { @@ -38582,27 +38884,24 @@ "format": "date-time", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" - }, - "parent": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - }, - "queries": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "searchTerms": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" } }, "type": "object" }, - "AdvancedSearchSynonymJsonApi": { + "AdvancedSearchActionSearchTermJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -38610,26 +38909,23 @@ { "required": [ "id", - "left" + "term", + "salesChannelId", + "actionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "term": { + "type": "string" }, - "right": { - "type": "array", - "items": { - "type": "string" - } + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "actionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38645,7 +38941,7 @@ }, "relationships": { "properties": { - "language": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -38653,7 +38949,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" + "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" } } }, @@ -38662,12 +38958,41 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "action": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "418c5509e2171d55b0aee5c2ea4442b5" } } } @@ -38682,29 +39007,26 @@ } ] }, - "AdvancedSearchSynonym": { + "AdvancedSearchActionSearchTerm": { "required": [ "id", - "left" + "term", + "salesChannelId", + "actionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "term": { + "type": "string" }, - "right": { - "type": "array", - "items": { - "type": "string" - } + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "actionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38718,14 +39040,16 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "action": { + "$ref": "#/components/schemas/AdvancedSearchAction" } }, "type": "object" }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", + "AdvancedSearchBoostingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -38733,136 +39057,42 @@ { "required": [ "id", + "boost", "name", - "path", - "version", - "integrationId", - "aclRoleId", - "label" + "configId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the app.", - "type": "string" - }, - "path": { - "description": "A relative URL to the app.", - "type": "string" - }, - "author": { - "description": "Creator of the App.", - "type": "string" + "validFrom": { + "type": "string", + "format": "date-time" }, - "copyright": { - "description": "Legal rights on the created app.", - "type": "string" + "validTo": { + "type": "string", + "format": "date-time" }, - "license": { - "description": "Software license's like MIT, etc.", - "type": "string" + "boost": { + "type": "number", + "format": "float" }, "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.", + "name": { "type": "string" }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "productStreamId": { "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", - "type": "boolean" - }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", - "type": "integer", - "format": "int64" - }, - "checkoutGatewayUrl": { - "type": "string" - }, - "contextGatewayUrl": { - "type": "string" - }, - "inAppPurchasesGatewayUrl": { - "type": "string" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { - "description": "Unique identity of integration.", + "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { - "description": "Unique identity of ACL Role.", + "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38876,12 +39106,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "integration": { + "productStream": { "properties": { "links": { "type": "object", @@ -38889,7 +39116,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" } } }, @@ -38898,19 +39125,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, - "aclRole": { + "entityStream": { "properties": { "links": { "type": "object", @@ -38918,7 +39145,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" } } }, @@ -38927,19 +39154,19 @@ "properties": { "type": { "type": "string", - "example": "acl_role" + "example": "advanced_search_entity_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "250aa1c64b973365fd6fd489eefbdefc" + "example": "62acf68da615789a0175ef827f74acbb" } } } }, "type": "object" }, - "customFieldSets": { + "config": { "properties": { "links": { "type": "object", @@ -38947,123 +39174,185 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" } } } }, "type": "object" - }, - "actionButtons": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchBoosting": { + "required": [ + "id", + "boost", + "name", + "configId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "boost": { + "type": "number", + "format": "float" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + }, + "type": "object" + }, + "AdvancedSearchConfigJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" - } - } + "maxSuggestCount": { + "type": "integer", + "format": "int64" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_action_button" - }, - "id": { - "type": "string", - "example": "2c7967427ed432e546ef1c0cb8d5da9e" - } - } - } + "maxSearchCount": { + "type": "integer", + "format": "int64" } }, "type": "object" }, - "templates": { + "product_manufacturer": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" - } - } + "maxSuggestCount": { + "type": "integer", + "format": "int64" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_template" - }, - "id": { - "type": "string", - "example": "fed36e93a0509e20f2dc96cbbd85b678" - } - } - } + "maxSearchCount": { + "type": "integer", + "format": "int64" } }, "type": "object" }, - "webhooks": { + "category": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" - } - } + "maxSuggestCount": { + "type": "integer", + "format": "int64" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook" - }, - "id": { - "type": "string", - "example": "c10f40999b74c408263f790b30e70efe" - } - } - } + "maxSearchCount": { + "type": "integer", + "format": "int64" } }, "type": "object" - }, - "paymentMethods": { + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -39071,30 +39360,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "taxProviders": { + "fields": { "properties": { "links": { "type": "object", @@ -39102,7 +39389,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" } } }, @@ -39113,11 +39400,11 @@ "properties": { "type": { "type": "string", - "example": "tax_provider" + "example": "advanced_search_config_field" }, "id": { "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" + "example": "d05b6ed7d2345020440df396d6da7f73" } } } @@ -39125,7 +39412,7 @@ }, "type": "object" }, - "cmsBlocks": { + "boostings": { "properties": { "links": { "type": "object", @@ -39133,7 +39420,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" } } }, @@ -39144,11 +39431,11 @@ "properties": { "type": { "type": "string", - "example": "app_cms_block" + "example": "advanced_search_boosting" }, "id": { "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" + "example": "8e571802e4ea39b214104ca60e13b5a6" } } } @@ -39156,7 +39443,7 @@ }, "type": "object" }, - "flowActions": { + "searchActions": { "properties": { "links": { "type": "object", @@ -39164,7 +39451,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/searchActions" } } }, @@ -39175,19 +39462,182 @@ "properties": { "type": { "type": "string", - "example": "app_flow_action" + "example": "advanced_search_action" }, "id": { "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + "example": "f7e07cbefd6755762faa802c35e48929" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchConfig": { + "required": [ + "id", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" }, - "flowEvents": { + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "product_manufacturer": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "category": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + }, + "boostings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + }, + "searchActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + }, + "type": "object" + }, + "AdvancedSearchConfigFieldJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configId", + "entity", + "field" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "field": { + "type": "string" + }, + "tokenize": { + "type": "boolean" + }, + "searchable": { + "type": "boolean" + }, + "ranking": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "config": { "properties": { "links": { "type": "object", @@ -39195,30 +39645,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { - "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" } } } }, "type": "object" }, - "appShippingMethods": { + "customField": { "properties": { "links": { "type": "object", @@ -39226,23 +39674,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ed2028a1c479c7e0065da597452d9c11" } } } @@ -39257,143 +39703,42 @@ } ] }, - "App": { - "description": "Added since version: 6.3.1.0", + "AdvancedSearchConfigField": { "required": [ "id", - "name", - "path", - "version", - "integrationId", - "aclRoleId", - "label" + "configId", + "entity", + "field" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the app.", - "type": "string" - }, - "path": { - "description": "A relative URL to the app.", - "type": "string" + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "author": { - "description": "Creator of the App.", - "type": "string" + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "copyright": { - "description": "Legal rights on the created app.", + "entity": { "type": "string" }, - "license": { - "description": "Software license's like MIT, etc.", + "field": { "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.", + "tokenize": { "type": "boolean" }, - "privacy": { - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", - "type": "string" - }, - "version": { - "description": "Version of the plugin.", - "type": "string" - }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "searchable": { "type": "boolean" }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", + "ranking": { "type": "integer", "format": "int64" }, - "checkoutGatewayUrl": { - "type": "string" - }, - "contextGatewayUrl": { - "type": "string" - }, - "inAppPurchasesGatewayUrl": { - "type": "string" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "integrationId": { - "description": "Unique identity of integration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "description": "Unique identity of ACL Role.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -39404,80 +39749,16 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "integration": { - "$ref": "#/components/schemas/Integration" - }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" - }, - "customFieldSets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - }, - "actionButtons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - }, - "templates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - }, - "taxProviders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - }, - "flowActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "customField": { + "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, - "AppActionButtonJsonApi": { - "description": "Added since version: 6.3.1.0", + "AdvancedSearchEntityStreamJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -39485,41 +39766,23 @@ { "required": [ "id", - "entity", - "view", - "url", - "action", - "appId", - "label" + "type" ], "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": { "type": "string" }, - "label": { - "type": "string" + "apiFilter": { + "type": "object", + "readOnly": true }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, "createdAt": { "type": "string", @@ -39531,12 +39794,40 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "filters": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "example": "2c9885d2b0c7e26971f60a90f33cf718" + } + } + } + } + }, + "type": "object" + }, + "boosting": { "properties": { "links": { "type": "object", @@ -39544,7 +39835,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" } } }, @@ -39553,12 +39844,12 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "advanced_search_boosting" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "6ab105abdd48ced24ce7b0e516ca0970" } } } @@ -39573,45 +39864,26 @@ } ] }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", + "AdvancedSearchEntityStream": { "required": [ "id", - "entity", - "view", - "url", - "action", - "appId", - "label" + "type" ], "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": { "type": "string" }, - "label": { - "type": "string" + "apiFilter": { + "type": "object", + "readOnly": true }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, "createdAt": { "type": "string", @@ -39623,17 +39895,19 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } }, - "app": { - "$ref": "#/components/schemas/App" + "boosting": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" } }, "type": "object" }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", + "AdvancedSearchEntityStreamFilterJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -39641,26 +39915,44 @@ { "required": [ "id", - "value", - "appId", - "localeId" + "entityStreamId", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" - }, - "appId": { + "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -39670,36 +39962,147 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "entityStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62acf68da615789a0175ef827f74acbb" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "queries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "example": "5da7eb4247add5dbd5776c9c0b38460a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", + "AdvancedSearchEntityStreamFilter": { "required": [ "id", - "value", - "appId", - "localeId" + "entityStreamId", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" - }, - "appId": { + "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -39709,12 +40112,23 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "parent": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + }, + "queries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } } }, "type": "object" }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", + "AdvancedSearchSynonymJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -39722,38 +40136,26 @@ { "required": [ "id", - "name", - "block", - "template", - "styles", - "appId", - "label" + "left" ], "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" + "left": { + "type": "array", + "items": { + "type": "string" + } }, - "label": { - "type": "string" + "right": { + "type": "array", + "items": { + "type": "string" + } }, - "appId": { - "description": "Unique identity of app.", + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39767,12 +40169,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "language": { "properties": { "links": { "type": "object", @@ -39780,7 +40179,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" } } }, @@ -39789,12 +40188,12 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -39809,42 +40208,29 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "AdvancedSearchSynonym": { "required": [ "id", - "name", - "block", - "template", - "styles", - "appId", - "label" + "left" ], "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" + "left": { + "type": "array", + "items": { + "type": "string" + } }, - "label": { - "type": "string" + "right": { + "type": "array", + "items": { + "type": "string" + } }, - "appId": { - "description": "Unique identity of app.", + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39858,17 +40244,14 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -39876,9 +40259,11 @@ { "required": [ "id", - "appId", "name", - "url", + "path", + "version", + "integrationId", + "aclRoleId", "label" ], "properties": { @@ -39886,63 +40271,127 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { - "description": "Name of app flow action.", + "description": "Name of the app.", "type": "string" }, - "badge": { + "path": { + "description": "A relative URL to the app.", "type": "string" }, - "parameters": { - "type": "object" + "author": { + "description": "Creator of the App.", + "type": "string" }, - "config": { - "type": "object" + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" }, - "headers": { + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { "type": "object" }, - "requirements": { + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { "type": "array", "items": { "type": "string" } }, - "iconRaw": { + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { "type": "string" }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true + "contextGatewayUrl": { + "type": "string" }, - "swIcon": { + "inAppPurchasesGatewayUrl": { "type": "string" }, - "url": { - "description": "An URL to app flow action.", + "sourceType": { "type": "string" }, - "delayable": { + "sourceConfig": { + "type": "object" + }, + "selfManaged": { "type": "boolean" }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, "description": { "type": "string" }, - "headline": { + "privacyPolicyExtensions": { "type": "string" }, "customFields": { "type": "object" }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -39958,7 +40407,65 @@ }, "relationships": { "properties": { - "app": { + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" + }, + "aclRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "250aa1c64b973365fd6fd489eefbdefc" + } + } + } + }, + "type": "object" + }, + "customFieldSets": { "properties": { "links": { "type": "object", @@ -39966,28 +40473,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + }, + "actionButtons": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "app" - }, - "id": { + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_action_button" + }, + "id": { + "type": "string", + "example": "2c7967427ed432e546ef1c0cb8d5da9e" + } + } + } + } + }, + "type": "object" + }, + "templates": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_template" + }, + "id": { + "type": "string", + "example": "fed36e93a0509e20f2dc96cbbd85b678" + } } } } }, "type": "object" }, - "flowSequences": { + "webhooks": { "properties": { "links": { "type": "object", @@ -39995,7 +40566,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" } } }, @@ -40006,171 +40577,19 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "webhook" }, "id": { "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + "example": "c10f40999b74c408263f790b30e70efe" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", - "required": [ - "id", - "appId", - "name", - "url", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of app flow action.", - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "description": "An URL to app flow action.", - "type": "string" - }, - "delayable": { - "type": "boolean" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "headline": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "flowSequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - }, - "type": "object" - }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appId", - "name", - "aware" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the AppFlowEvent.", - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { + }, + "paymentMethods": { "properties": { "links": { "type": "object", @@ -40178,28 +40597,123 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "app" - }, - "id": { + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } + } + }, + "type": "object" + }, + "flowActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + } } } } }, "type": "object" }, - "flows": { + "flowEvents": { "properties": { "links": { "type": "object", @@ -40207,7 +40721,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" } } }, @@ -40218,11 +40732,42 @@ "properties": { "type": { "type": "string", - "example": "flow" + "example": "app_flow_event" }, "id": { "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" + "example": "045e9ec14eafd26d17854fb4fe7c9cae" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } @@ -40238,37 +40783,143 @@ } ] }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", + "App": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "appId", "name", - "aware" + "path", + "version", + "integrationId", + "aclRoleId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "description": "Unique identity of app.", + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "name": { - "description": "Unique name of the AppFlowEvent.", + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, - "aware": { + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { "type": "array", "items": { "type": "string" } }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, "customFields": { "type": "object" }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40279,20 +40930,80 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "translated": { + "type": "object" }, - "flows": { + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { "type": "array", "items": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + }, + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + }, + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + }, + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" } } }, "type": "object" }, - "AppPaymentMethodJsonApi": { - "description": "Added since version: 6.4.1.0", + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -40300,45 +41011,35 @@ { "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "description": "Name of the app.", - "type": "string" - }, - "identifier": { - "description": "It is a unique identity of an AppPaymentMethod.", - "type": "string" - }, - "payUrl": { - "description": "A URL sending the pay request.", - "type": "string" - }, - "finalizeUrl": { - "description": "A URL that redirects the user back to the shop.", + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "validateUrl": { - "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, - "captureUrl": { - "description": "A capture URL allows the payments to be processed and completed once validated.", + "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, - "refundUrl": { - "description": "A refund URL is used to initiate the refund process for a purchase.", + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, - "recurringUrl": { - "description": "A URL to payment to handle recurring orders like subscriptions.", + "label": { "type": "string" }, "appId": { @@ -40346,16 +41047,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { - "description": "Unique identity of original media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "description": "Unique identity of payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -40366,6 +41057,9 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { "app": { @@ -40376,7 +41070,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, @@ -40396,64 +41090,6 @@ } }, "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" @@ -40463,49 +41099,39 @@ } ] }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", + "AppActionButton": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "description": "Name of the app.", - "type": "string" - }, - "identifier": { - "description": "It is a unique identity of an AppPaymentMethod.", - "type": "string" - }, - "payUrl": { - "description": "A URL sending the pay request.", - "type": "string" - }, - "finalizeUrl": { - "description": "A URL that redirects the user back to the shop.", + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "validateUrl": { - "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, - "captureUrl": { - "description": "A capture URL allows the payments to be processed and completed once validated.", + "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, - "refundUrl": { - "description": "A refund URL is used to initiate the refund process for a purchase.", + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, - "recurringUrl": { - "description": "A URL to payment to handle recurring orders like subscriptions.", + "label": { "type": "string" }, "appId": { @@ -40513,16 +41139,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { - "description": "Unique identity of original media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "description": "Unique identity of payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -40533,20 +41149,17 @@ "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" }, - "AppScriptConditionJsonApi": { - "description": "Added since version: 6.4.10.3", + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -40554,40 +41167,23 @@ { "required": [ "id", - "identifier", - "active", + "value", "appId", - "name" + "localeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "description": "It is a unique identity of an AppScriptCondition.", - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, defined app script conditions are available for selection.", - "type": "boolean" - }, - "group": { - "description": "Categorizes script conditions within a specific group.", - "type": "string" - }, - "script": { - "description": "Internal field.", + "value": { "type": "string" }, - "config": { - "type": "object" - }, "appId": { - "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40600,118 +41196,33 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } - }, - "type": "object" - }, - "ruleConditions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule_condition" - }, - "id": { - "type": "string", - "example": "24bfabce4195894c9aed9b8bcfb0b748" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" } ] }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", "required": [ "id", - "identifier", - "active", + "value", "appId", - "name" + "localeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "description": "It is a unique identity of an AppScriptCondition.", - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, defined app script conditions are available for selection.", - "type": "boolean" - }, - "group": { - "description": "Categorizes script conditions within a specific group.", - "type": "string" - }, - "script": { - "description": "Internal field.", + "value": { "type": "string" }, - "config": { - "type": "object" - }, "appId": { - "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40724,24 +41235,12 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "ruleConditions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } } }, "type": "object" }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -40749,30 +41248,38 @@ { "required": [ "id", - "appName", - "identifier", - "shippingMethodId" + "name", + "block", + "template", + "styles", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { + "name": { + "description": "Name of app's CMS block.", "type": "string" }, - "identifier": { + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "type": "string" }, - "originalMediaId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40786,6 +41293,9 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { "app": { @@ -40796,7 +41306,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" } } }, @@ -40816,64 +41326,6 @@ } }, "type": "object" - }, - "shippingMethod": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" - } - } - } - }, - "type": "object" - }, - "originalMedia": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -40882,35 +41334,43 @@ "type": "object" } ] - }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", "required": [ "id", - "appName", - "identifier", - "shippingMethodId" + "name", + "block", + "template", + "styles", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { + "name": { + "description": "Name of app's CMS block.", "type": "string" }, - "identifier": { + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "type": "string" }, - "originalMediaId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40924,20 +41384,17 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "app": { "$ref": "#/components/schemas/App" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -40945,36 +41402,73 @@ { "required": [ "id", - "template", - "path", - "active", - "appId" + "appId", + "name", + "url", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { - "description": "Template for an app.", + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", "type": "string" }, - "path": { - "description": "A relative URL to the app template.", + "badge": { "type": "string" }, - "active": { - "description": "When boolean value is `true`, defined app templates are available for selection.", - "type": "boolean" + "parameters": { + "type": "object" }, - "appId": { - "description": "Unique identity of app.", + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "hash": { + "swIcon": { "type": "string" }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40985,6 +41479,9 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { "app": { @@ -40995,7 +41492,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, @@ -41015,6 +41512,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" @@ -41024,40 +41552,77 @@ } ] }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ "id", - "template", - "path", - "active", - "appId" + "appId", + "name", + "url", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { - "description": "Template for an app.", + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", "type": "string" }, - "path": { - "description": "A relative URL to the app template.", + "badge": { "type": "string" }, - "active": { - "description": "When boolean value is `true`, defined app templates are available for selection.", - "type": "boolean" + "parameters": { + "type": "object" }, - "appId": { - "description": "Unique identity of app.", + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "hash": { + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { "type": "string" }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41068,33 +41633,53 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "app": { "$ref": "#/components/schemas/App" + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } } }, "type": "object" }, - "B2bBusinessPartnerJsonApi": { + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "id" + "id", + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { - "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" @@ -41111,7 +41696,7 @@ }, "relationships": { "properties": { - "customer": { + "app": { "properties": { "links": { "type": "object", @@ -41119,7 +41704,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, @@ -41128,19 +41713,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "defaultRole": { + "flows": { "properties": { "links": { "type": "object", @@ -41148,21 +41733,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_role" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2944ea414640901d532eba5106eb706b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "example": "0db2dd944f9ee9a131f44b79d331d371" + } } } } @@ -41177,22 +41764,33 @@ } ] }, - "B2bBusinessPartner": { + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ - "id" + "id", + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { - "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" @@ -41207,17 +41805,20 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "app": { + "$ref": "#/components/schemas/App" }, - "defaultRole": { - "$ref": "#/components/schemas/B2bComponentsRole" + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } }, "type": "object" }, - "B2bComponentsAdvancedProductCatalogsJsonApi": { - "description": "Added since version: 6.7.1.0", + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -41225,45 +41826,62 @@ { "required": [ "id", - "customerId", - "organizationId", - "salesChannelId" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoAddNewCategories": { - "type": "boolean" + "appName": { + "description": "Name of the app.", + "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" }, - "customerGroupId": { + "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}$" }, - "organizationId": { + "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -41276,123 +41894,7 @@ }, "relationships": { "properties": { - "customerGroup": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customerGroup" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" - } - } - } - }, - "type": "object" - }, - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - }, - "organization": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/organization" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" - } - } - } - }, - "type": "object" - }, - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - }, - "updatedBy": { + "app": { "properties": { "links": { "type": "object", @@ -41400,7 +41902,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/updatedBy" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, @@ -41409,19 +41911,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "salesChannels": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -41429,7 +41931,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannels" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, @@ -41438,19 +41940,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, - "salesChannel": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -41458,7 +41960,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannel" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, @@ -41467,19 +41969,170 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" - }, - "advancedProductCatalogsCategories": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "identifier", + "active", + "appId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" + }, + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" + }, + "script": { + "description": "Internal field.", + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { "properties": { "links": { "type": "object", @@ -41487,30 +42140,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/advancedProductCatalogsCategories" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs_category" - }, - "id": { - "type": "string", - "example": "0a628ceb24e0f626e3355b2ffac1c2f7" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "categories": { + "ruleConditions": { "properties": { "links": { "type": "object", @@ -41518,7 +42169,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/categories" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, @@ -41529,11 +42180,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "rule_condition" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "24bfabce4195894c9aed9b8bcfb0b748" } } } @@ -41549,49 +42200,47 @@ } ] }, - "B2bComponentsAdvancedProductCatalogs": { - "description": "Added since version: 6.7.1.0", + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", "required": [ "id", - "customerId", - "organizationId", - "salesChannelId" + "identifier", + "active", + "appId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoAddNewCategories": { - "type": "boolean" + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "script": { + "description": "Internal field.", + "type": "string" }, - "organizationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "salesChannelId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -41602,75 +42251,23 @@ "format": "date-time", "readOnly": true }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "organization": { - "$ref": "#/components/schemas/B2bComponentsOrganization" - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "salesChannels": { - "$ref": "#/components/schemas/SalesChannel" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "translated": { + "type": "object" }, - "advancedProductCatalogsCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogsCategory" - } + "app": { + "$ref": "#/components/schemas/App" }, - "categories": { + "ruleConditions": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, - "B2bComponentsAdvancedProductCatalogsCategory": { - "required": [ - "advancedProductCatalogsId", - "categoryId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "advancedProductCatalogsId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "advancedProductCatalog": { - "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" - }, - "category": { - "$ref": "#/components/schemas/Category" - } - }, - "type": "object" - }, - "B2bComponentsApprovalRuleJsonApi": { - "description": "Added since version: 6.6.0.0", + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -41678,46 +42275,32 @@ { "required": [ "id", - "name", - "priority", - "active", - "conditions" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { + "appName": { "type": "string" }, - "description": { + "identifier": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "affectedRoleId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -41731,7 +42314,7 @@ }, "relationships": { "properties": { - "businessPartnerCustomer": { + "app": { "properties": { "links": { "type": "object", @@ -41739,7 +42322,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" } } }, @@ -41748,19 +42331,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "reviewerRole": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -41768,7 +42351,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" } } }, @@ -41777,19 +42360,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06ec286ee4d03afb4028caa32c0ef40b" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "affectedRole": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -41797,7 +42380,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" } } }, @@ -41806,19 +42389,131 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "33237c6057eedd7b8c978f77270af3b1" + "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" - }, - "pendingOrders": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", + "required": [ + "id", + "appName", + "identifier", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "template", + "path", + "active", + "appId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { "properties": { "links": { "type": "object", @@ -41826,23 +42521,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "2a7cfaa402d9b52e7ecd072ae390d84b" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -41857,50 +42550,39 @@ } ] }, - "B2bComponentsApprovalRule": { - "description": "Added since version: 6.6.0.0", + "AppTemplate": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "name", - "priority", + "template", + "path", "active", - "conditions" + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { + "template": { + "description": "Template for an app.", "type": "string" }, - "description": { + "path": { + "description": "A relative URL to the app template.", "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" - }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "affectedRoleId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "hash": { + "type": "string" }, "createdAt": { "type": "string", @@ -41912,64 +42594,37 @@ "format": "date-time", "readOnly": true }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" - }, - "reviewerRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "affectedRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "pendingOrders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - } + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { - "description": "Added since version: 6.6.3.0", + "B2bBusinessPartnerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "id", - "identifier", - "active", - "appId" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" - }, - "config": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "defaultRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41980,12 +42635,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "customer": { "properties": { "links": { "type": "object", @@ -41993,7 +42645,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" } } }, @@ -42002,12 +42654,41 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "defaultRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2944ea414640901d532eba5106eb706b" } } } @@ -42022,41 +42703,26 @@ } ] }, - "B2bComponentsApprovalRuleAppScriptCondition": { - "description": "Added since version: 6.6.3.0", + "B2bBusinessPartner": { "required": [ - "id", - "identifier", - "active", - "appId" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" - }, - "config": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "defaultRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42067,17 +42733,17 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "app": { - "$ref": "#/components/schemas/App" + "defaultRole": { + "$ref": "#/components/schemas/B2bComponentsRole" } }, "type": "object" }, - "B2bComponentsBudgetJsonApi": { - "description": "Added since version: 6.7.4.0", + "B2bComponentsAdvancedProductCatalogsJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -42085,98 +42751,45 @@ { "required": [ "id", - "name", - "technicalName", - "amount", - "startDate", - "currencyId" + "customerId", + "organizationId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "costCentre": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "active": { + "autoAddNewCategories": { "type": "boolean" }, - "amount": { - "type": "number", - "format": "float" - }, - "usedAmount": { - "type": "number", - "format": "float", - "readOnly": true - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "renewsType": { - "type": "string" - }, - "lastRenews": { + "createdById": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "nextRenews": { + "updatedById": { "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" + "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reviewerRoleId": { + "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42189,7 +42802,7 @@ }, "relationships": { "properties": { - "createdBy": { + "customerGroup": { "properties": { "links": { "type": "object", @@ -42197,7 +42810,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/createdBy" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customerGroup" } } }, @@ -42206,12 +42819,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "115091b01a7299f28a5ce7e1b712a222" } } } @@ -42226,7 +42839,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/customer" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customer" } } }, @@ -42247,7 +42860,7 @@ }, "type": "object" }, - "organizations": { + "organization": { "properties": { "links": { "type": "object", @@ -42255,30 +42868,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/organizations" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/organization" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "d9811f03b461a380c0d6b4a497dbac37" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, - "notificationRecipients": { + "createdBy": { "properties": { "links": { "type": "object", @@ -42286,30 +42897,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/notificationRecipients" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "bd4a2b3045182246fac51c0abc10c4d7" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "reviewerRole": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -42317,7 +42926,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/reviewerRole" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/updatedBy" } } }, @@ -42326,19 +42935,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06ec286ee4d03afb4028caa32c0ef40b" + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, - "currency": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -42346,7 +42955,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/currency" + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannels" } } }, @@ -42355,12 +42964,103 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } @@ -42375,102 +43075,49 @@ } ] }, - "B2bComponentsBudget": { - "description": "Added since version: 6.7.4.0", + "B2bComponentsAdvancedProductCatalogs": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "name", - "technicalName", - "amount", - "startDate", - "currencyId" + "customerId", + "organizationId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "costCentre": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "active": { + "autoAddNewCategories": { "type": "boolean" }, - "amount": { - "type": "number", - "format": "float" - }, - "usedAmount": { - "type": "number", - "format": "float", - "readOnly": true - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "renewsType": { - "type": "string" - }, - "lastRenews": { + "createdById": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "nextRenews": { + "updatedById": { "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" + "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reviewerRoleId": { + "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42481,90 +43128,75 @@ "format": "date-time", "readOnly": true }, - "createdBy": { - "$ref": "#/components/schemas/User" + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, "customer": { "$ref": "#/components/schemas/Customer" }, - "organizations": { + "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/B2bComponentsOrganization" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogsCategory" } }, - "notificationRecipients": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/Category" } - }, - "reviewerRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "currency": { - "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "B2bComponentsBudgetNotificationRecipient": { - "description": "Added since version: 6.7.4.0", + "B2bComponentsAdvancedProductCatalogsCategory": { "required": [ - "budgetId", - "employeeId" + "advancedProductCatalogsId", + "categoryId" ], "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": { + "advancedProductCatalogsId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "budgetId": { + "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "organizationId": { + "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "budget": { - "$ref": "#/components/schemas/B2bComponentsBudget" + "advancedProductCatalog": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" }, - "organization": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "category": { + "$ref": "#/components/schemas/Category" } }, "type": "object" }, - "B2bComponentsEmployeeWishlistJsonApi": { + "B2bComponentsApprovalRuleJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -42572,19 +43204,41 @@ { "required": [ "id", - "employeeId", - "salesChannelId" + "name", + "priority", + "active", + "conditions" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { + "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42603,7 +43257,7 @@ }, "relationships": { "properties": { - "employee": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -42611,7 +43265,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/employee" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" } } }, @@ -42620,19 +43274,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" }, - "salesChannel": { + "reviewerRole": { "properties": { "links": { "type": "object", @@ -42640,7 +43294,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/salesChannel" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" } } }, @@ -42649,19 +43303,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "06ec286ee4d03afb4028caa32c0ef40b" } } } }, "type": "object" }, - "products": { + "affectedRole": { "properties": { "links": { "type": "object", @@ -42669,7 +43323,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/products" + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "33237c6057eedd7b8c978f77270af3b1" + } + } + } + }, + "type": "object" + }, + "pendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" } } }, @@ -42680,11 +43363,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_employee_wishlist_product" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "2a7cfaa402d9b52e7ecd072ae390d84b" } } } @@ -42700,22 +43383,45 @@ } ] }, - "B2bComponentsEmployeeWishlist": { + "B2bComponentsApprovalRule": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "employeeId", - "salesChannelId" + "name", + "priority", + "active", + "conditions" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { + "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42732,22 +43438,26 @@ "format": "date-time", "readOnly": true }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" }, - "products": { + "affectedRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "pendingOrders": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } }, "type": "object" }, - "B2bComponentsEmployeeWishlistProductJsonApi": { + "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { + "description": "Added since version: 6.6.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -42755,30 +43465,37 @@ { "required": [ "id", - "employeeWishlistId", - "productId", - "productVersionId" + "identifier", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeWishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "type": "string" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "customFields": { + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { "type": "object" }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42789,38 +43506,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "employeeWishlist": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/employeeWishlist" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_employee_wishlist" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "396edf0709663088597d101284333942" - } - } - } - }, - "type": "object" - }, - "product": { + "app": { "properties": { "links": { "type": "object", @@ -42828,7 +43519,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/product" + "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" } } }, @@ -42837,12 +43528,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -42857,33 +43548,41 @@ } ] }, - "B2bComponentsEmployeeWishlistProduct": { + "B2bComponentsApprovalRuleAppScriptCondition": { + "description": "Added since version: 6.6.3.0", "required": [ "id", - "employeeWishlistId", - "productId", - "productVersionId" + "identifier", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeWishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "type": "string" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "customFields": { + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { "type": "object" }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42894,17 +43593,17 @@ "format": "date-time", "readOnly": true }, - "employeeWishlist": { - "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" + "translated": { + "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "B2bComponentsIndividualPricingJsonApi": { - "description": "Added since version: 6.7.8.0", + "B2bComponentsBudgetJsonApi": { + "description": "Added since version: 6.7.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -42912,81 +43611,97 @@ { "required": [ "id", - "active", - "showStrikeThrough", "name", - "target", - "priority", - "applyToAllProducts", - "useValidityRange", - "actionType", - "tiers" + "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" }, - "showStrikeThrough": { - "type": "boolean" + "amount": { + "type": "number", + "format": "float" }, - "name": { + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { "type": "string" }, - "target": { + "endDate": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" + "renewsType": { + "type": "string" }, - "applyToAllProducts": { - "type": "boolean" + "lastRenews": { + "type": "string", + "readOnly": true }, - "productStreamId": { + "nextRenews": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "useValidityRange": { + "allowApproval": { "type": "boolean" }, - "validFrom": { - "type": "string" + "showRemaining": { + "type": "boolean" }, - "validUntil": { - "type": "string" + "notify": { + "type": "boolean" }, - "description": { - "type": "string" + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" }, - "actionType": { - "type": "string" + "sent": { + "type": "boolean", + "readOnly": true }, - "actionAmount": { - "type": "number", - "format": "float" + "customFields": { + "type": "object" }, - "createdById": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -43008,7 +43723,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/createdBy" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/createdBy" } } }, @@ -43029,36 +43744,7 @@ }, "type": "object" }, - "updatedBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/updatedBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" - } - } - } - }, - "type": "object" - }, - "productStream": { + "customer": { "properties": { "links": { "type": "object", @@ -43066,7 +43752,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/productStream" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/customer" } } }, @@ -43075,19 +43761,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "tiers": { + "organizations": { "properties": { "links": { "type": "object", @@ -43095,7 +43781,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tiers" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/organizations" } } }, @@ -43106,11 +43792,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing_tier" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "49f466e28285d1d4989b49139c4b265e" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -43118,7 +43804,7 @@ }, "type": "object" }, - "companyAssignments": { + "notificationRecipients": { "properties": { "links": { "type": "object", @@ -43126,7 +43812,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/companyAssignments" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/notificationRecipients" } } }, @@ -43137,11 +43823,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "e02294f7c7e9c5f3829bfcc5fc9aadd6" + "example": "bd4a2b3045182246fac51c0abc10c4d7" } } } @@ -43149,7 +43835,7 @@ }, "type": "object" }, - "tags": { + "reviewerRole": { "properties": { "links": { "type": "object", @@ -43157,30 +43843,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/reviewerRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06ec286ee4d03afb4028caa32c0ef40b" } } } }, "type": "object" }, - "products": { + "currency": { "properties": { "links": { "type": "object", @@ -43188,23 +43872,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/products" + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/currency" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } @@ -43219,85 +43901,101 @@ } ] }, - "B2bComponentsIndividualPricing": { - "description": "Added since version: 6.7.8.0", + "B2bComponentsBudget": { + "description": "Added since version: 6.7.4.0", "required": [ "id", - "active", - "showStrikeThrough", "name", - "target", - "priority", - "applyToAllProducts", - "useValidityRange", - "actionType", - "tiers" + "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" }, - "showStrikeThrough": { - "type": "boolean" + "amount": { + "type": "number", + "format": "float" }, - "name": { + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { "type": "string" }, - "target": { + "endDate": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" + "renewsType": { + "type": "string" }, - "applyToAllProducts": { - "type": "boolean" + "lastRenews": { + "type": "string", + "readOnly": true }, - "productStreamId": { + "nextRenews": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "useValidityRange": { + "allowApproval": { "type": "boolean" }, - "validFrom": { - "type": "string" + "showRemaining": { + "type": "boolean" }, - "validUntil": { - "type": "string" + "notify": { + "type": "boolean" }, - "description": { - "type": "string" + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" }, - "actionType": { - "type": "string" + "sent": { + "type": "boolean", + "readOnly": true }, - "actionAmount": { - "type": "number", - "format": "float" + "customFields": { + "type": "object" }, - "createdById": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -43312,41 +44010,87 @@ "createdBy": { "$ref": "#/components/schemas/User" }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "tiers": { + "organizations": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" + "$ref": "#/components/schemas/B2bComponentsOrganization" } }, - "companyAssignments": { + "notificationRecipients": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + "$ref": "#/components/schemas/B2bEmployee" } }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "currency": { + "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "B2bComponentsIndividualPricingCompanyAssignmentJsonApi": { - "description": "Added since version: 6.7.8.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" @@ -43354,33 +44098,24 @@ { "required": [ "id", - "individualPricingId", - "customerId", - "scope" + "employeeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "individualPricingId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "scope": { - "type": "string" - }, - "organizationUnitIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -43394,7 +44129,7 @@ }, "relationships": { "properties": { - "individualPricing": { + "employee": { "properties": { "links": { "type": "object", @@ -43402,7 +44137,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/individualPricing" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/employee" } } }, @@ -43411,19 +44146,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "5fe7ef4389efb412d4e35056093e10ab" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, - "customer": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -43431,7 +44166,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/customer" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/salesChannel" } } }, @@ -43440,19 +44175,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "units": { + "products": { "properties": { "links": { "type": "object", @@ -43460,7 +44195,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/units" + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/products" } } }, @@ -43471,11 +44206,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", - "example": "b98b3dfbd27e710e6c3ceeae58770b52" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -43491,219 +44226,28 @@ } ] }, - "B2bComponentsIndividualPricingCompanyAssignment": { - "description": "Added since version: 6.7.8.0", - "required": [ - "id", - "individualPricingId", - "customerId", - "scope" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "individualPricingId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "scope": { - "type": "string" - }, - "organizationUnitIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "individualPricing": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricing" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsOrganization" - } - } - }, - "type": "object" - }, - "B2bComponentsIndividualPricingCompanyAssignmentUnit": { - "description": "Added since version: 6.7.8.0", - "required": [ - "assignmentId", - "orgUnitId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "assignmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orgUnitId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "assignment": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" - }, - "orgUnit": { - "$ref": "#/components/schemas/B2bComponentsOrganization" - } - }, - "type": "object" - }, - "B2bComponentsIndividualPricingComputedCacheJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "individualPricingId", - "actionType", - "priority", - "activatedAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "individualPricingId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionType": { - "type": "string" - }, - "actionAmount": { - "type": "number", - "format": "float" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validUntil": { - "type": "string", - "format": "date-time" - }, - "showStrikeThrough": { - "type": "boolean" - }, - "price": { - "type": "object" - }, - "activatedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - } - ] - }, - "B2bComponentsIndividualPricingComputedCache": { + "B2bComponentsEmployeeWishlist": { "required": [ "id", - "individualPricingId", - "actionType", - "priority", - "activatedAt" + "employeeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "individualPricingId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "actionType": { - "type": "string" - }, - "actionAmount": { - "type": "number", - "format": "float" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validUntil": { - "type": "string", - "format": "date-time" - }, - "showStrikeThrough": { - "type": "boolean" - }, - "price": { + "customFields": { "type": "object" }, - "activatedAt": { - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -43713,73 +44257,53 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "B2bComponentsIndividualPricingTag": { - "description": "Added since version: 6.7.8.0", - "required": [ - "individualPricingId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "individualPricingId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "employee": { + "$ref": "#/components/schemas/B2bEmployee" }, - "individualPricing": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" + } } }, "type": "object" }, - "B2bComponentsIndividualPricingTierJsonApi": { - "description": "Added since version: 6.7.8.0", + "B2bComponentsEmployeeWishlistProductJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "individualPricingId", "id", - "qtyFrom", - "price" + "employeeWishlistId", + "productId", + "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "individualPricingId": { + "employeeWishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "qtyFrom": { - "type": "integer", - "format": "int64" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "qtyTo": { - "type": "integer", - "format": "int64" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -43793,7 +44317,7 @@ }, "relationships": { "properties": { - "individualPricing": { + "employeeWishlist": { "properties": { "links": { "type": "object", @@ -43801,7 +44325,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-individual-pricing-tier/8430b2435525569963232095b1a5a6dd/individualPricing" + "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/employeeWishlist" } } }, @@ -43810,12 +44334,41 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing" + "example": "b2b_components_employee_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "5fe7ef4389efb412d4e35056093e10ab" + "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" } } } @@ -43830,36 +44383,32 @@ } ] }, - "B2bComponentsIndividualPricingTier": { - "description": "Added since version: 6.7.8.0", + "B2bComponentsEmployeeWishlistProduct": { "required": [ - "individualPricingId", "id", - "qtyFrom", - "price" + "employeeWishlistId", + "productId", + "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "individualPricingId": { + "employeeWishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "qtyFrom": { - "type": "integer", - "format": "int64" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "qtyTo": { - "type": "integer", - "format": "int64" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -43871,13 +44420,17 @@ "format": "date-time", "readOnly": true }, - "individualPricing": { - "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + "employeeWishlist": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "B2bComponentsOrganizationJsonApi": { + "B2bComponentsIndividualPricingJsonApi": { + "description": "Added since version: 6.7.8.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -43885,31 +44438,63 @@ { "required": [ "id", + "active", + "showStrikeThrough", "name", - "customerId", - "defaultShippingAddressId", - "defaultBillingAddressId" + "target", + "priority", + "applyToAllProducts", + "useValidityRange", + "actionType", + "tiers" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "active": { + "type": "boolean" + }, + "showStrikeThrough": { + "type": "boolean" + }, "name": { "type": "string" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "target": { + "type": "string" }, - "defaultShippingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "defaultBillingAddressId": { + "applyToAllProducts": { + "type": "boolean" + }, + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "useValidityRange": { + "type": "boolean" + }, + "validFrom": { + "type": "string" + }, + "validUntil": { + "type": "string" + }, + "description": { + "type": "string" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -43918,6 +44503,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, "customFields": { "type": "object" }, @@ -43931,9 +44524,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "advancedProductCatalogs": { + "createdBy": { "properties": { "links": { "type": "object", @@ -43941,61 +44534,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { - "type": "string", - "example": "fbec40add5492465d78b550a9a4ae26e" - } - } - } - } - }, - "type": "object" - }, - "budgets": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" - } + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "individualPricingCompanyAssignmentUnits": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -44003,66 +44563,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment_unit" - }, - "id": { - "type": "string", - "example": "2de375eb5502ab387a10c69ea5789649" - } - } - } - } - }, - "type": "object" - }, - "individualPricingCompanyAssignments": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" - }, - "id": { - "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" - } + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customer": { + }, + "productStream": { "properties": { "links": { "type": "object", @@ -44070,7 +44592,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/customer" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/productStream" } } }, @@ -44079,19 +44601,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, - "employees": { + "tiers": { "properties": { "links": { "type": "object", @@ -44099,7 +44621,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/employees" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tiers" } } }, @@ -44110,11 +44632,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "b2b_components_individual_pricing_tier" }, "id": { "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + "example": "49f466e28285d1d4989b49139c4b265e" } } } @@ -44122,7 +44644,7 @@ }, "type": "object" }, - "organizationCustomerAddresses": { + "companyAssignments": { "properties": { "links": { "type": "object", @@ -44130,7 +44652,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/organizationCustomerAddresses" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/companyAssignments" } } }, @@ -44141,11 +44663,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization_customer_address" + "example": "b2b_components_individual_pricing_company_assignment" }, "id": { "type": "string", - "example": "ada6a19a929bea8dbec29edb3d68df58" + "example": "e02294f7c7e9c5f3829bfcc5fc9aadd6" } } } @@ -44153,7 +44675,7 @@ }, "type": "object" }, - "paymentMethods": { + "tags": { "properties": { "links": { "type": "object", @@ -44161,7 +44683,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/paymentMethods" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tags" } } }, @@ -44172,11 +44694,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "tag" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -44184,7 +44706,7 @@ }, "type": "object" }, - "shippingMethods": { + "products": { "properties": { "links": { "type": "object", @@ -44192,7 +44714,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/shippingMethods" + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/products" } } }, @@ -44203,48 +44725,202 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "product" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - }, - "defaultShippingAddress": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" - } - } - } - }, - "type": "object" - }, - "defaultBillingAddress": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsIndividualPricing": { + "description": "Added since version: 6.7.8.0", + "required": [ + "id", + "active", + "showStrikeThrough", + "name", + "target", + "priority", + "applyToAllProducts", + "useValidityRange", + "actionType", + "tiers" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "target": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "applyToAllProducts": { + "type": "boolean" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useValidityRange": { + "type": "boolean" + }, + "validFrom": { + "type": "string" + }, + "validUntil": { + "type": "string" + }, + "description": { + "type": "string" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "tiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" + } + }, + "companyAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingCompanyAssignmentJsonApi": { + "description": "Added since version: 6.7.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "individualPricingId", + "customerId", + "scope" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scope": { + "type": "string" + }, + "organizationUnitIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "individualPricing": { "properties": { "links": { "type": "object", @@ -44252,7 +44928,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultBillingAddress" + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/individualPricing" } } }, @@ -44261,19 +44937,19 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" + "example": "5fe7ef4389efb412d4e35056093e10ab" } } } }, "type": "object" }, - "createdBy": { + "customer": { "properties": { "links": { "type": "object", @@ -44281,7 +44957,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/createdBy" + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/customer" } } }, @@ -44290,19 +44966,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "updatedBy": { + "units": { "properties": { "links": { "type": "object", @@ -44310,21 +44986,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/updatedBy" + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/units" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } } } } @@ -44339,44 +45017,37 @@ } ] }, - "B2bComponentsOrganization": { + "B2bComponentsIndividualPricingCompanyAssignment": { + "description": "Added since version: 6.7.8.0", "required": [ "id", - "name", + "individualPricingId", "customerId", - "defaultShippingAddressId", - "defaultBillingAddressId" + "scope" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { + "individualPricingId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "scope": { + "type": "string" }, - "customFields": { - "type": "object" + "organizationUnitIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, "createdAt": { "type": "string", @@ -44388,178 +45059,50 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "advancedProductCatalogs": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { - "type": "string", - "example": "fbec40add5492465d78b550a9a4ae26e" - } - } - } - } - }, - "type": "object" - }, - "budgets": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" - } - } - } - } - }, - "type": "object" - }, - "individualPricingCompanyAssignmentUnits": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment_unit" - }, - "id": { - "type": "string", - "example": "2de375eb5502ab387a10c69ea5789649" - } - } - } - } - }, - "type": "object" - }, - "individualPricingCompanyAssignments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" - }, - "id": { - "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" }, "customer": { "$ref": "#/components/schemas/Customer" }, - "employees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bEmployee" - } - }, - "organizationCustomerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" - } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - }, - "shippingMethods": { + "units": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/B2bComponentsOrganization" } + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingCompanyAssignmentUnit": { + "description": "Added since version: 6.7.8.0", + "required": [ + "assignmentId", + "orgUnitId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "assignmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "orgUnitId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "assignment": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "orgUnit": { + "$ref": "#/components/schemas/B2bComponentsOrganization" } }, "type": "object" }, - "B2bComponentsOrganizationCustomerAddressJsonApi": { + "B2bComponentsIndividualPricingComputedCacheJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -44567,26 +45110,57 @@ { "required": [ "id", - "organizationId", - "customerAddressId", - "type" + "individualPricingId", + "actionType", + "priority", + "activatedAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "organizationId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerAddressId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionType": { "type": "string" }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "price": { + "type": "object" + }, + "activatedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -44599,7 +45173,7 @@ }, "relationships": { "properties": { - "customerAddress": { + "product": { "properties": { "links": { "type": "object", @@ -44607,7 +45181,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-organization-customer-address/01f4816d6912a00b6c3f7cfd02672e16/customerAddress" + "example": "/b2b-components-individual-pricing-computed-cache/844b7f47ba74cc63454301f0b4ca1c82/product" } } }, @@ -44616,12 +45190,12 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ede14a49881da866970ac311e0ac78f8" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -44636,29 +45210,60 @@ } ] }, - "B2bComponentsOrganizationCustomerAddress": { + "B2bComponentsIndividualPricingComputedCache": { "required": [ "id", - "organizationId", - "customerAddressId", - "type" + "individualPricingId", + "actionType", + "priority", + "activatedAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "organizationId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerAddressId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionType": { "type": "string" }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "price": { + "type": "object" + }, + "activatedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -44669,68 +45274,173 @@ "format": "date-time", "readOnly": true }, - "customerAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "B2bComponentsOrganizationPaymentMethod": { + "B2bComponentsIndividualPricingTag": { + "description": "Added since version: 6.7.8.0", "required": [ - "b2bComponentsOrganizationId", - "paymentMethodId" + "individualPricingId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "b2bComponentsOrganizationId": { + "individualPricingId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "b2bComponentsOrganization": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "B2bComponentsOrganizationShippingMethod": { + "B2bComponentsIndividualPricingTierJsonApi": { + "description": "Added since version: 6.7.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "individualPricingId", + "id", + "qtyFrom", + "price" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "qtyFrom": { + "type": "integer", + "format": "int64" + }, + "qtyTo": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "individualPricing": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing-tier/8430b2435525569963232095b1a5a6dd/individualPricing" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5fe7ef4389efb412d4e35056093e10ab" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsIndividualPricingTier": { + "description": "Added since version: 6.7.8.0", "required": [ - "b2bComponentsOrganizationId", - "shippingMethodId" + "individualPricingId", + "id", + "qtyFrom", + "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "b2bComponentsOrganizationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "qtyFrom": { + "type": "integer", + "format": "int64" + }, + "qtyTo": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, - "shippingMethodId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "b2bComponentsOrganization": { - "$ref": "#/components/schemas/B2bComponentsOrganization" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } }, "type": "object" }, - "B2bComponentsPendingOrderJsonApi": { - "description": "Added since version: 6.6.0.0", + "B2bComponentsOrganizationJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -44738,204 +45448,39 @@ { "required": [ "id", - "billingAddressId", + "name", "customerId", - "employeeId", - "stateId", - "currencyId", - "countryId", - "salesChannelId", - "shippingMethodId", - "paymentMethodId", - "languageId", - "number", - "cartPayload", - "itemRounding", - "totalRounding", - "lineItemCount" + "defaultShippingAddressId", + "defaultBillingAddressId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "decidedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "approvalRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { + "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "number": { - "type": "string" - }, - "cartPayload": { - "type": "string" - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "originalPrice": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reason": { - "type": "string" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "lineItemCount": { - "type": "integer", - "format": "int64" - }, - "designatedPayerIds": { - "type": "array", - "items": { - "type": "string" - } - }, "customFields": { "type": "object" }, @@ -44951,70 +45496,7 @@ }, "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": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" - } - } - } - }, - "type": "object" - }, - "billingAddress": { + "advancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -45022,28 +45504,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7fee8ff88b768662dd8fc06e1b6997d2" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } } } } }, "type": "object" }, - "customer": { + "budgets": { "properties": { "links": { "type": "object", @@ -45051,28 +45535,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } } } } }, "type": "object" }, - "employee": { + "individualPricingCompanyAssignmentUnits": { "properties": { "links": { "type": "object", @@ -45080,28 +45566,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment_unit" + }, + "id": { + "type": "string", + "example": "2de375eb5502ab387a10c69ea5789649" + } } } } }, "type": "object" }, - "decidedBy": { + "individualPricingCompanyAssignments": { "properties": { "links": { "type": "object", @@ -45109,28 +45597,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b293e6616bcffea8e393a4066a4a4230" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" + } } } } }, "type": "object" - }, - "approvalRule": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customer": { "properties": { "links": { "type": "object", @@ -45138,7 +45633,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/customer" } } }, @@ -45147,19 +45642,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "stateMachineState": { + "employees": { "properties": { "links": { "type": "object", @@ -45167,28 +45662,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/employees" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } } } } }, "type": "object" }, - "currency": { + "organizationCustomerAddresses": { "properties": { "links": { "type": "object", @@ -45196,28 +45693,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/currency" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/organizationCustomerAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" + } } } } }, "type": "object" }, - "country": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -45225,28 +45724,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/paymentMethods" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } } } } }, "type": "object" }, - "salesChannel": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -45254,28 +45755,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/salesChannel" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/shippingMethods" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } } } } }, "type": "object" }, - "language": { + "defaultShippingAddress": { "properties": { "links": { "type": "object", @@ -45283,7 +45786,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultShippingAddress" } } }, @@ -45292,19 +45795,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "8218c377171d06883caea7e2baf67f31" } } } }, "type": "object" }, - "paymentMethod": { + "defaultBillingAddress": { "properties": { "links": { "type": "object", @@ -45312,7 +45815,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultBillingAddress" } } }, @@ -45321,19 +45824,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } }, "type": "object" }, - "shippingMethod": { + "createdBy": { "properties": { "links": { "type": "object", @@ -45341,7 +45844,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/createdBy" } } }, @@ -45350,19 +45853,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "addresses": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -45370,23 +45873,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order_address" - }, - "id": { - "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -45401,208 +45902,42 @@ } ] }, - "B2bComponentsPendingOrder": { - "description": "Added since version: 6.6.0.0", + "B2bComponentsOrganization": { "required": [ "id", - "billingAddressId", + "name", "customerId", - "employeeId", - "stateId", - "currencyId", - "countryId", - "salesChannelId", - "shippingMethodId", - "paymentMethodId", - "languageId", - "number", - "cartPayload", - "itemRounding", - "totalRounding", - "lineItemCount" + "defaultShippingAddressId", + "defaultBillingAddressId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "decidedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "approvalRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { + "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "number": { - "type": "string" - }, - "cartPayload": { - "type": "string" - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "originalPrice": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reason": { - "type": "string" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "lineItemCount": { - "type": "integer", - "format": "int64" - }, - "designatedPayerIds": { - "type": "array", - "items": { - "type": "string" - } - }, "customFields": { "type": "object" }, @@ -45618,7 +45953,7 @@ }, "extensions": { "properties": { - "budget": { + "advancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -45626,21 +45961,116 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "b2b_components_budget" - }, - "id": { + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignmentUnits": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment_unit" + }, + "id": { + "type": "string", + "example": "2de375eb5502ab387a10c69ea5789649" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" + } } } } @@ -45650,55 +46080,219 @@ }, "type": "object" }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "billingAddress": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - }, "customer": { "$ref": "#/components/schemas/Customer" }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "employees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } }, - "decidedBy": { - "$ref": "#/components/schemas/B2bEmployee" + "organizationCustomerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + } }, - "approvalRule": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } }, - "currency": { - "$ref": "#/components/schemas/Currency" + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" }, - "country": { - "$ref": "#/components/schemas/Country" + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationCustomerAddressJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "organizationId", + "customerAddressId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customerAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization-customer-address/01f4816d6912a00b6c3f7cfd02672e16/customerAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ede14a49881da866970ac311e0ac78f8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsOrganizationCustomerAddress": { + "required": [ + "id", + "organizationId", + "customerAddressId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customerAddress": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationPaymentMethod": { + "required": [ + "b2bComponentsOrganizationId", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "language": { - "$ref": "#/components/schemas/Language" + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationShippingMethod": { + "required": [ + "b2bComponentsOrganizationId", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" - }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - } } }, "type": "object" }, - "B2bComponentsPendingOrderAddressJsonApi": { + "B2bComponentsPendingOrderJsonApi": { "description": "Added since version: 6.6.0.0", "allOf": [ { @@ -45707,69 +46301,203 @@ { "required": [ "id", + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", "countryId", - "pendingOrderId", - "firstName", - "lastName", - "street", - "city" + "salesChannelId", + "shippingMethodId", + "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "decidedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "approvalRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pendingOrderId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "lastName": { + "number": { "type": "string" }, - "street": { + "cartPayload": { "type": "string" }, - "zipcode": { - "type": "string" + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" }, - "city": { - "type": "string" + "originalPrice": { + "type": "number", + "format": "float" }, - "company": { - "type": "string" + "taxStatus": { + "type": "string", + "readOnly": true }, - "department": { - "type": "string" + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true }, - "title": { - "type": "string" + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true }, - "vatId": { + "reason": { "type": "string" }, - "phoneNumber": { - "type": "string" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "additionalAddressLine1": { - "type": "string" + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "additionalAddressLine2": { - "type": "string" + "lineItemCount": { + "type": "integer", + "format": "int64" + }, + "designatedPayerIds": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" @@ -45784,9 +46512,43 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "country": { + "order": { "properties": { "links": { "type": "object", @@ -45794,7 +46556,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/country" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" } } }, @@ -45803,19 +46565,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "countryState": { + "billingAddress": { "properties": { "links": { "type": "object", @@ -45823,7 +46585,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" } } }, @@ -45832,19 +46594,19 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" }, - "pendingOrder": { + "customer": { "properties": { "links": { "type": "object", @@ -45852,7 +46614,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" } } }, @@ -45861,19 +46623,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1fd94955ea55110a2cf95eeb6fb1679f" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "salutation": { + "employee": { "properties": { "links": { "type": "object", @@ -45881,7 +46643,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" } } }, @@ -45890,19 +46652,19 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, - "billingAddressPendingOrders": { + "decidedBy": { "properties": { "links": { "type": "object", @@ -45910,188 +46672,57 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/billingAddressPendingOrders" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "b4e47f63a7c39869d14bf20e25a45489" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b293e6616bcffea8e393a4066a4a4230" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsPendingOrderAddress": { - "description": "Added since version: 6.6.0.0", - "required": [ - "id", - "countryId", - "pendingOrderId", - "firstName", - "lastName", - "street", - "city" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pendingOrderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "street": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { - "type": "string" - }, - "vatId": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "additionalAddressLine1": { - "type": "string" - }, - "additionalAddressLine2": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "pendingOrder": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - }, - "billingAddressPendingOrders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - } - } - }, - "type": "object" - }, - "B2bComponentsRoleJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "customFields": { - "type": "object" - }, - "default": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "b2bBusinessPartner": { + }, + "approvalRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" + } + } + } + }, + "type": "object" + }, + "stateMachineState": { "properties": { "links": { "type": "object", @@ -46099,7 +46730,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" } } }, @@ -46108,19 +46739,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_business_partner" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "b2bReviewerApprovalRules": { + "currency": { "properties": { "links": { "type": "object", @@ -46128,30 +46759,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/currency" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule" - }, - "id": { - "type": "string", - "example": "25fd4841a35dd38cba144c6a480b52bb" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "b2bAffectedApprovalRules": { + "country": { "properties": { "links": { "type": "object", @@ -46159,30 +46788,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule" - }, - "id": { - "type": "string", - "example": "844042c07d902b98a574a2e21845c1e6" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "reviewerBudgets": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -46190,35 +46817,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "cc0b9649925b8bf844adbf00bc3b3346" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "employees": { + }, + "language": { "properties": { "links": { "type": "object", @@ -46226,30 +46846,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "businessPartnerCustomer": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -46257,7 +46875,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" } } }, @@ -46266,12 +46884,72 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "addresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } } } } @@ -46286,37 +46964,211 @@ } ] }, - "B2bComponentsRole": { + "B2bComponentsPendingOrder": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "name" + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", + "countryId", + "salesChannelId", + "shippingMethodId", + "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "decidedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "approvalRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "number": { "type": "string" }, - "permissions": { + "cartPayload": { + "type": "string" + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "originalPrice": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reason": { + "type": "string" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "lineItemCount": { + "type": "integer", + "format": "int64" + }, + "designatedPayerIds": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "customFields": { "type": "object" }, - "default": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -46329,7 +47181,7 @@ }, "extensions": { "properties": { - "b2bBusinessPartner": { + "budget": { "properties": { "links": { "type": "object", @@ -46337,7 +47189,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" } } }, @@ -46346,105 +47198,12 @@ "properties": { "type": { "type": "string", - "example": "b2b_business_partner" + "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" - } - } - } - }, - "type": "object" - }, - "b2bReviewerApprovalRules": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule" - }, - "id": { - "type": "string", - "example": "25fd4841a35dd38cba144c6a480b52bb" - } - } - } - } - }, - "type": "object" - }, - "b2bAffectedApprovalRules": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule" - }, - "id": { - "type": "string", - "example": "844042c07d902b98a574a2e21845c1e6" - } - } - } - } - }, - "type": "object" - }, - "reviewerBudgets": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "cc0b9649925b8bf844adbf00bc3b3346" - } + "example": "2f212049ce79d2b949fd242043004288" } } } @@ -46454,20 +47213,56 @@ }, "type": "object" }, - "employees": { + "order": { + "$ref": "#/components/schemas/Order" + }, + "billingAddress": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "decidedBy": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "approvalRule": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "addresses": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } - }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "B2bComponentsShoppingListJsonApi": { - "description": "Added since version: 6.6.2.0", + "B2bComponentsPendingOrderAddressJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -46475,49 +47270,73 @@ { "required": [ "id", - "salesChannelId", - "customerId" + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "salesChannelId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "pendingOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" }, "customFields": { "type": "object" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -46528,72 +47347,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "organization": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "createdBy": { + "country": { "properties": { "links": { "type": "object", @@ -46601,7 +47357,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/createdBy" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/country" } } }, @@ -46610,19 +47366,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "updatedBy": { + "countryState": { "properties": { "links": { "type": "object", @@ -46630,7 +47386,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" } } }, @@ -46639,19 +47395,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "customer": { + "pendingOrder": { "properties": { "links": { "type": "object", @@ -46659,7 +47415,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" } } }, @@ -46668,19 +47424,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "b2b_components_pending_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "1fd94955ea55110a2cf95eeb6fb1679f" } } } }, "type": "object" }, - "employee": { + "salutation": { "properties": { "links": { "type": "object", @@ -46688,7 +47444,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" } } }, @@ -46697,19 +47453,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "lineItems": { + "billingAddressPendingOrders": { "properties": { "links": { "type": "object", @@ -46717,7 +47473,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/billingAddressPendingOrders" } } }, @@ -46728,11 +47484,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list_line_item" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" + "example": "b4e47f63a7c39869d14bf20e25a45489" } } } @@ -46748,53 +47504,77 @@ } ] }, - "B2bComponentsShoppingList": { - "description": "Added since version: 6.6.2.0", + "B2bComponentsPendingOrderAddress": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "salesChannelId", - "customerId" + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "salesChannelId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "pendingOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" }, "customFields": { "type": "object" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -46805,66 +47585,28 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "organization": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "createdBy": { - "$ref": "#/components/schemas/User" + "country": { + "$ref": "#/components/schemas/Country" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "pendingOrder": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "salutation": { + "$ref": "#/components/schemas/Salutation" }, - "lineItems": { + "billingAddressPendingOrders": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } }, "type": "object" }, - "B2bComponentsShoppingListLineItemJsonApi": { - "description": "Added since version: 6.6.2.0", + "B2bComponentsRoleJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -46872,38 +47614,34 @@ { "required": [ "id", - "quantity" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shoppingListId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "price": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/Price" + "type": "object", + "additionalProperties": false } }, - "quantity": { - "type": "integer", - "format": "int64" - }, "customFields": { "type": "object" }, + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -46914,9 +47652,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "shoppingList": { + "b2bBusinessPartner": { "properties": { "links": { "type": "object", @@ -46924,7 +47662,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" } } }, @@ -46933,19 +47671,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list" + "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "75cf6f56c85d6cbfe36939709500418b" + "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, - "product": { + "b2bReviewerApprovalRules": { "properties": { "links": { "type": "object", @@ -46953,127 +47691,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "25fd4841a35dd38cba144c6a480b52bb" + } + } + } + } + }, + "type": "object" + }, + "b2bAffectedApprovalRules": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "844042c07d902b98a574a2e21845c1e6" + } } } } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsShoppingListLineItem": { - "description": "Added since version: 6.6.2.0", - "required": [ - "id", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shoppingListId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "shoppingList": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" - }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "B2bComponentsSubscriptionEmployeeJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "subscriptionId", - "employeeId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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": { + }, + "type": "object" + }, + "reviewerBudgets": { "properties": { "links": { "type": "object", @@ -47081,28 +47753,66 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/subscription" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "cc0b9649925b8bf844adbf00bc3b3346" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "employees": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } } } } }, "type": "object" }, - "employee": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -47110,7 +47820,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/employee" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" } } }, @@ -47119,12 +47829,12 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } @@ -47139,24 +47849,36 @@ } ] }, - "B2bComponentsSubscriptionEmployee": { + "B2bComponentsRole": { "required": [ "id", - "subscriptionId", - "employeeId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionId": { + "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" + }, + "permissions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "customFields": { + "type": "object" + }, + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -47168,16 +47890,147 @@ "format": "date-time", "readOnly": true }, - "subscription": { - "$ref": "#/components/schemas/Subscription" + "extensions": { + "properties": { + "b2bBusinessPartner": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_business_partner" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c1736d678c9ca2f952db2f7894193bf3" + } + } + } + }, + "type": "object" + }, + "b2bReviewerApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "25fd4841a35dd38cba144c6a480b52bb" + } + } + } + } + }, + "type": "object" + }, + "b2bAffectedApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "844042c07d902b98a574a2e21845c1e6" + } + } + } + } + }, + "type": "object" + }, + "reviewerBudgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "cc0b9649925b8bf844adbf00bc3b3346" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "employees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "B2bEmployeeJsonApi": { + "B2bComponentsShoppingListJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -47185,51 +48038,48 @@ { "required": [ "id", - "languageId", - "firstName", - "lastName", - "email" + "salesChannelId", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true + "name": { + "type": "string" }, - "businessPartnerCustomerId": { + "active": { + "type": "boolean" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "roleId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "recoveryTime": { + "employeeId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "status": { - "type": "string" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -47243,68 +48093,6 @@ }, "extensions": { "properties": { - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_employee" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - }, - "quoteComments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" - } - } - } - } - }, - "type": "object" - }, "organization": { "properties": { "links": { @@ -47313,7 +48101,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, @@ -47333,8 +48121,13 @@ } }, "type": "object" - }, - "b2bOrderEmployees": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -47342,61 +48135,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_order_employee" - }, - "id": { - "type": "string", - "example": "6d4a2ca331b1f28767d02f210af4ac7b" - } - } - } - } - }, - "type": "object" - }, - "subscriptionEmployees": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_subscription_employee" - }, - "id": { - "type": "string", - "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" - } + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "b2bPendingOrders": { + "createdBy": { "properties": { "links": { "type": "object", @@ -47404,61 +48164,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } - } - } - } - }, - "type": "object" - }, - "b2bDecidedPendingOrders": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "c231abdb725547458353efbf48c35d43" - } + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "shoppingLists": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -47466,66 +48193,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list" - }, - "id": { - "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" - } - } - } - } - }, - "type": "object" - }, - "budgetNotifications": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "a6b1894d8fb4962df1b416d3a3241bbb" - } + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "businessPartnerCustomer": { + }, + "customer": { "properties": { "links": { "type": "object", @@ -47533,7 +48222,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/businessPartnerCustomer" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" } } }, @@ -47547,14 +48236,14 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "role": { + "employee": { "properties": { "links": { "type": "object", @@ -47562,7 +48251,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/role" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" } } }, @@ -47571,19 +48260,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "29a7e96467b69a9f5a93332e29e9b0de" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, - "language": { + "lineItems": { "properties": { "links": { "type": "object", @@ -47591,21 +48280,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/language" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } } } } @@ -47620,54 +48311,52 @@ } ] }, - "B2bEmployee": { + "B2bComponentsShoppingList": { + "description": "Added since version: 6.6.2.0", "required": [ "id", - "languageId", - "firstName", - "lastName", - "email" + "salesChannelId", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true + "name": { + "type": "string" }, - "businessPartnerCustomerId": { + "active": { + "type": "boolean" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "roleId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "recoveryTime": { + "employeeId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "status": { - "type": "string" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -47681,68 +48370,6 @@ }, "extensions": { "properties": { - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_employee" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - }, - "quoteComments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" - } - } - } - } - }, - "type": "object" - }, "organization": { "properties": { "links": { @@ -47751,7 +48378,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, @@ -47771,209 +48398,36 @@ } }, "type": "object" - }, - "b2bOrderEmployees": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_order_employee" - }, - "id": { - "type": "string", - "example": "6d4a2ca331b1f28767d02f210af4ac7b" - } - } - } - } - }, - "type": "object" - }, - "subscriptionEmployees": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_subscription_employee" - }, - "id": { - "type": "string", - "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } - } - } - } - }, - "type": "object" - }, - "b2bDecidedPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "c231abdb725547458353efbf48c35d43" - } - } - } - } - }, - "type": "object" - }, - "shoppingLists": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list" - }, - "id": { - "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" - } - } - } - } - }, - "type": "object" - }, - "budgetNotifications": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "a6b1894d8fb4962df1b416d3a3241bbb" - } - } - } - } - }, - "type": "object" } }, "type": "object" }, - "businessPartnerCustomer": { + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "customer": { "$ref": "#/components/schemas/Customer" }, - "role": { - "$ref": "#/components/schemas/B2bComponentsRole" + "employee": { + "$ref": "#/components/schemas/B2bEmployee" }, - "language": { - "$ref": "#/components/schemas/Language" + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } } }, "type": "object" }, - "B2bOrderEmployeeJsonApi": { + "B2bComponentsShoppingListLineItemJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -47981,36 +48435,37 @@ { "required": [ "id", - "orderId", - "firstName", - "lastName" + "quantity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, - "lastName": { - "type": "string" + "quantity": { + "type": "integer", + "format": "int64" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -48024,7 +48479,7 @@ }, "relationships": { "properties": { - "order": { + "shoppingList": { "properties": { "links": { "type": "object", @@ -48032,7 +48487,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/order" + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" } } }, @@ -48041,19 +48496,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "75cf6f56c85d6cbfe36939709500418b" } } } }, "type": "object" }, - "employee": { + "product": { "properties": { "links": { "type": "object", @@ -48061,7 +48516,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/employee" + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" } } }, @@ -48070,12 +48525,12 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -48090,39 +48545,41 @@ } ] }, - "B2bOrderEmployee": { + "B2bComponentsShoppingListLineItem": { + "description": "Added since version: 6.6.2.0", "required": [ "id", - "orderId", - "firstName", - "lastName" + "quantity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, - "lastName": { - "type": "string" + "quantity": { + "type": "integer", + "format": "int64" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -48134,16 +48591,16 @@ "format": "date-time", "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" + "shoppingList": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "B2bPermissionJsonApi": { + "B2bComponentsSubscriptionEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -48151,25 +48608,21 @@ { "required": [ "id", - "name", - "group" + "subscriptionId", + "employeeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "group": { - "type": "string" + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -48180,34 +48633,93 @@ "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" } ] }, - "B2bPermission": { + "B2bComponentsSubscriptionEmployee": { "required": [ "id", - "name", - "group" + "subscriptionId", + "employeeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "group": { - "type": "string" + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -48218,12 +48730,17 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "subscription": { + "$ref": "#/components/schemas/Subscription" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, - "CategoryJsonApi": { - "description": "Added since version: 6.0.0.0", + "B2bEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -48231,160 +48748,51 @@ { "required": [ "id", - "name" + "languageId", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "businessPartnerCustomerId": { "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "linkType": { + "roleId": { "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] + "pattern": "^[0-9a-f]{32}$" }, - "internalLink": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { + "firstName": { "type": "string" }, - "metaDescription": { + "lastName": { "type": "string" }, - "keywords": { + "email": { "type": "string" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productStreamId": { - "description": "Unique identity of product stream.", + "recoveryTime": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "status": { + "type": "string" }, "createdAt": { "type": "string", @@ -48396,15 +48804,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "search": { - "type": "object" - }, - "advancedProductCatalogs": { + "quotes": { "properties": { "links": { "type": "object", @@ -48412,7 +48814,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" } } }, @@ -48423,11 +48825,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "quote_employee" }, "id": { "type": "string", - "example": "fbec40add5492465d78b550a9a4ae26e" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -48435,7 +48837,7 @@ }, "type": "object" }, - "advancedProductCatalogsCategories": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -48443,7 +48845,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" } } }, @@ -48454,25 +48856,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs_category" + "example": "quote_comment" }, "id": { "type": "string", - "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of category.", + }, + "organization": { "properties": { "links": { "type": "object", @@ -48480,7 +48876,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" } } }, @@ -48489,20 +48885,19 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, - "children": { - "description": "Child categories within this category for hierarchical navigation", + "b2bOrderEmployees": { "properties": { "links": { "type": "object", @@ -48510,7 +48905,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" } } }, @@ -48521,11 +48916,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "b2b_order_employee" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "6d4a2ca331b1f28767d02f210af4ac7b" } } } @@ -48533,37 +48928,7 @@ }, "type": "object" }, - "media": { - "description": "Category image or banner", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } - } - } - }, - "type": "object" - }, - "products": { + "subscriptionEmployees": { "properties": { "links": { "type": "object", @@ -48571,7 +48936,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" } } }, @@ -48582,11 +48947,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "b2b_components_subscription_employee" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" } } } @@ -48594,7 +48959,7 @@ }, "type": "object" }, - "nestedProducts": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -48602,7 +48967,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" } } }, @@ -48613,11 +48978,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "cf73cebf9ade7f94deba94ec71e66e43" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -48625,8 +48990,7 @@ }, "type": "object" }, - "tags": { - "description": "Tags for organizing and filtering categories", + "b2bDecidedPendingOrders": { "properties": { "links": { "type": "object", @@ -48634,7 +48998,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" } } }, @@ -48645,11 +49009,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "c231abdb725547458353efbf48c35d43" } } } @@ -48657,66 +49021,7 @@ }, "type": "object" }, - "cmsPage": { - "description": "CMS page layout for the category", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } - } - } - }, - "type": "object" - }, - "productStream": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" - } - } - } - }, - "type": "object" - }, - "navigationSalesChannels": { + "shoppingLists": { "properties": { "links": { "type": "object", @@ -48724,7 +49029,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" } } }, @@ -48735,11 +49040,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "04db458d860e0a4b455ae14b384a5e8a" + "example": "efa2c2d016771a1e072e6b05091fb584" } } } @@ -48747,7 +49052,7 @@ }, "type": "object" }, - "footerSalesChannels": { + "budgetNotifications": { "properties": { "links": { "type": "object", @@ -48755,7 +49060,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" } } }, @@ -48766,19 +49071,24 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "b2b_components_budget" }, "id": { "type": "string", - "example": "57944aba1f6dea7ca9dacf66776e1755" + "example": "a6b1894d8fb4962df1b416d3a3241bbb" } } } } }, "type": "object" - }, - "serviceSalesChannels": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -48786,30 +49096,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/businessPartnerCustomer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "1a79932fadba3b20baf6369181e45602" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" }, - "mainCategories": { + "role": { "properties": { "links": { "type": "object", @@ -48817,31 +49125,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/role" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "main_category" - }, - "id": { - "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "29a7e96467b69a9f5a93332e29e9b0de" } } } }, "type": "object" }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", + "language": { "properties": { "links": { "type": "object", @@ -48849,23 +49154,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/language" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -48880,164 +49183,54 @@ } ] }, - "Category": { - "description": "Added since version: 6.0.0.0", + "B2bEmployee": { "required": [ "id", - "name" + "languageId", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { + "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "businessPartnerCustomerId": { "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "linkType": { + "roleId": { "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] + "pattern": "^[0-9a-f]{32}$" }, - "internalLink": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { + "firstName": { "type": "string" }, - "metaDescription": { + "lastName": { "type": "string" }, - "keywords": { + "email": { "type": "string" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productStreamId": { - "description": "Unique identity of product stream.", + "recoveryTime": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "status": { + "type": "string" }, "createdAt": { "type": "string", @@ -49049,15 +49242,40 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "search": { + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_employee" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, "type": "object" }, - "advancedProductCatalogs": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -49065,7 +49283,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" } } }, @@ -49076,11 +49294,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "quote_comment" }, "id": { "type": "string", - "example": "fbec40add5492465d78b550a9a4ae26e" + "example": "98dec49a83119c512f84645e81ea52d8" } } } @@ -49088,7 +49306,7 @@ }, "type": "object" }, - "advancedProductCatalogsCategories": { + "organization": { "properties": { "links": { "type": "object", @@ -49096,7 +49314,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + }, + "b2bOrderEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" } } }, @@ -49107,11 +49354,166 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs_category" + "example": "b2b_order_employee" }, "id": { "type": "string", - "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + "example": "6d4a2ca331b1f28767d02f210af4ac7b" + } + } + } + } + }, + "type": "object" + }, + "subscriptionEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "b2bDecidedPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c231abdb725547458353efbf48c35d43" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } + } + } + } + }, + "type": "object" + }, + "budgetNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "a6b1894d8fb4962df1b416d3a3241bbb" } } } @@ -49122,114 +49524,268 @@ }, "type": "object" }, - "parent": { - "$ref": "#/components/schemas/Category", - "description": "Unique identity of category." + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "role": { + "$ref": "#/components/schemas/B2bComponentsRole" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Category image or banner" + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "B2bOrderEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + { + "required": [ + "id", + "orderId", + "firstName", + "lastName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "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": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/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" + } + ] + }, + "B2bOrderEmployee": { + "required": [ + "id", + "orderId", + "firstName", + "lastName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "nestedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tags": { - "description": "Tags for organizing and filtering categories", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the category" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "firstName": { + "type": "string" }, - "navigationSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "lastName": { + "type": "string" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "serviceSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "order": { + "$ref": "#/components/schemas/Order" }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "employee": { + "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, - "CategoryTag": { - "description": "Added since version: 6.0.0.0", + "B2bPermissionJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "group" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "group": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "B2bPermission": { "required": [ - "categoryId", - "tagId" + "id", + "name", + "group" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "group": { + "type": "string" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "dependencies": { + "type": "array", + "items": { + "type": "string" + } }, - "category": { - "$ref": "#/components/schemas/Category" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tag": { - "$ref": "#/components/schemas/Tag" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "CmsBlockJsonApi": { + "ProductJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -49238,9 +49794,11 @@ { "required": [ "id", - "position", - "type", - "sectionId" + "taxId", + "price", + "productNumber", + "stock", + "name" ], "properties": { "id": { @@ -49251,84 +49809,321 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsSectionVersionId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "description": "Unique identity of feature set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "type": "string" + }, + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, - "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "locked": { + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true }, - "sectionPosition": { - "description": "Position of the section. It can either be `main` or `sidebar`.", + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" + }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "marginTop": { - "description": "Defines the margin area on the top of an element.", + "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", + "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" + }, + "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", + "type": "number", + "format": "float" + }, + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" + }, + "purchasePrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" + }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true + }, + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", + "type": "boolean" + }, + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaDescription": { "type": "string" }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", + "name": { "type": "string" }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", + "keywords": { "type": "string" }, - "backgroundColor": { - "description": "Defines the background color of an element.", + "description": { "type": "string" }, - "backgroundMediaId": { - "description": "Unique identity of background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "metaTitle": { + "type": "string" }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "packUnit": { "type": "string" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", + "packUnitPlural": { "type": "string" }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, + "customFields": { "type": "object" }, - "sectionId": { - "description": "Unique identity of section.", + "slotConfig": { + "type": "object" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "physical", + "digital" + ] }, - "customFields": { - "type": "object" + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true }, "createdAt": { "type": "string", @@ -49340,9 +50135,12 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "section": { + "customPrice": { "properties": { "links": { "type": "object", @@ -49350,28 +50148,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" + "example": "/product/deb10517653c255364175796ace3553f/customPrice" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" + }, + "subscriptionPlans": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "cms_section" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "73d5342eba070f636ac3246f319bf77f" + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } } } } }, "type": "object" }, - "backgroundMedia": { + "warehouseGroups": { "properties": { "links": { "type": "object", @@ -49379,28 +50210,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } } } } }, "type": "object" }, - "slots": { + "warehouses": { "properties": { "links": { "type": "object", @@ -49408,7 +50241,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" + "example": "/product/deb10517653c255364175796ace3553f/warehouses" } } }, @@ -49419,218 +50252,19 @@ "properties": { "type": { "type": "string", - "example": "cms_slot" + "example": "product_warehouse" }, "id": { "type": "string", - "example": "a8b72798beb911ae98c8c8907d45950a" + "example": "544959798565126142ca2820b4f56271" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CmsBlock": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "position", - "type", - "sectionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" - }, - "sectionPosition": { - "description": "Position of the section. It can either be `main` or `sidebar`.", - "type": "string" - }, - "marginTop": { - "description": "Defines the margin area on the top of an element.", - "type": "string" - }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", - "type": "string" - }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", - "type": "string" - }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", - "type": "string" - }, - "backgroundColor": { - "description": "Defines the background color of an element.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "sectionId": { - "description": "Unique identity of section.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "section": { - "$ref": "#/components/schemas/CmsSection" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "slots": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - }, - "type": "object" - }, - "CmsPageJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", - "type": "string" - }, - "entity": { - "description": "This field will be implemented in the future.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "config": { - "properties": { - "backgroundColor": { - "type": "string" - } - }, - "type": "object" - }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "locked": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", + }, + "orderWarehouses": { "properties": { "links": { "type": "object", @@ -49638,7 +50272,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } } }, @@ -49649,11 +50283,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "order_product_warehouse" }, "id": { "type": "string", - "example": "ff4dee88db82e98f0e0d524d965b9aa7" + "example": "5331369e2f71d048521bd35d80975314" } } } @@ -49661,8 +50295,7 @@ }, "type": "object" }, - "previewMedia": { - "description": "Preview image for the CMS page in admin panel and page selection", + "reviewSummaries": { "properties": { "links": { "type": "object", @@ -49670,28 +50303,33 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a7a817fb0e422cff87e878b8ff7ca914" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" + } } } } }, "type": "object" }, - "categories": { + "search": { + "type": "object" + }, + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -49699,7 +50337,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } } }, @@ -49710,11 +50348,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "quote_line_item" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "6b1c17ad551ef636e491ab6848f68420" } } } @@ -49722,8 +50360,7 @@ }, "type": "object" }, - "landingPages": { - "description": "Landing pages using this CMS layout", + "shoppingListLineItems": { "properties": { "links": { "type": "object", @@ -49731,7 +50368,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } } }, @@ -49742,11 +50379,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "ce593c6d1db236f22dc387a2ee20dfd6" } } } @@ -49754,7 +50391,8 @@ }, "type": "object" }, - "homeSalesChannels": { + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", "properties": { "links": { "type": "object", @@ -49762,7 +50400,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" } } }, @@ -49773,11 +50411,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "bundle_item" }, "id": { "type": "string", - "example": "9aed0c38161f67f2d40a4a872cae045f" + "example": "d7706d2e11bc4878ffb242403ea5b274" } } } @@ -49785,7 +50423,8 @@ }, "type": "object" }, - "products": { + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", "properties": { "links": { "type": "object", @@ -49793,7 +50432,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" } } }, @@ -49804,233 +50443,20 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "bundle_discount" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "a79712cce6d0182645b519f6add10f77" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CmsPage": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", - "type": "string" - }, - "entity": { - "description": "This field will be implemented in the future.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "config": { - "properties": { - "backgroundColor": { - "type": "string" - } - }, - "type": "object" - }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "locked": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - }, - "previewMedia": { - "$ref": "#/components/schemas/Media", - "description": "Preview image for the CMS page in admin panel and page selection" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "landingPages": { - "description": "Landing pages using this CMS layout", - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - }, - "homeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - }, - "type": "object" - }, - "CmsSectionJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "position", - "type", - "pageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" - }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" - }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" - }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "page": { + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", "properties": { "links": { "type": "object", @@ -50038,28 +50464,32 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "71860c77c6745379b0d44304d66b6a13" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" + } } } } }, - "type": "object" + "type": "object", + "readOnly": true }, - "backgroundMedia": { + "items": { + "description": "Products referenced as bundle items of this bundle.", "properties": { "links": { "type": "object", @@ -50067,28 +50497,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" + "example": "/product/deb10517653c255364175796ace3553f/items" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" + } } } } }, "type": "object" }, - "blocks": { + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", "properties": { "links": { "type": "object", @@ -50096,7 +50529,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" } } }, @@ -50107,210 +50540,20 @@ "properties": { "type": { "type": "string", - "example": "cms_block" + "example": "bundle_item" }, "id": { "type": "string", - "example": "e734964953f880e5164e32827950ff92" + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CmsSection": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "position", - "type", - "pageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" - }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" - }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" - }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "page": { - "$ref": "#/components/schemas/CmsPage" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "blocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - } - }, - "type": "object" - }, - "CmsSlotJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "type", - "slot", - "blockId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "type": { - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", - "type": "string" - }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "block": { + }, + "bundles": { + "description": "Bundles that include this product as an item.", "properties": { "links": { "type": "object", @@ -50318,250 +50561,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" + "example": "/product/deb10517653c255364175796ace3553f/bundles" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "14511f2f5564650d129ca7cabc333278" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CmsSlot": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "type", - "slot", - "blockId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "type": { - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", - "type": "string" - }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "block": { - "$ref": "#/components/schemas/CmsBlock" - } - }, - "type": "object" - }, - "CountryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "addressFormat" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", - "type": "boolean" - }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", - "type": "string" - }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" - }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" - }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" - }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", - "type": "boolean" - }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "companyTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" - }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" - }, - "addressFormat": { - "type": "object" - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { + "employeeWishlists": { "properties": { "links": { "type": "object", @@ -50569,7 +50592,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" } } }, @@ -50580,11 +50603,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "e91afc4e24376c8b995cece3ce354b4e" } } } @@ -50592,7 +50615,7 @@ }, "type": "object" }, - "b2bPendingOrders": { + "individualPricingComputedCaches": { "properties": { "links": { "type": "object", @@ -50600,7 +50623,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" + "example": "/product/deb10517653c255364175796ace3553f/individualPricingComputedCaches" } } }, @@ -50611,11 +50634,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "b2b_components_individual_pricing_computed_cache" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "0208611f8e65e3ceffe9b336ea836127" } } } @@ -50623,7 +50646,7 @@ }, "type": "object" }, - "b2bPendingOrderAddresses": { + "individualPricings": { "properties": { "links": { "type": "object", @@ -50631,7 +50654,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" } } }, @@ -50642,11 +50665,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order_address" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "7c55a27217c16d4e6395eb18a7f3be2f" + "example": "5246e417af07e49dc4961c49d4ad6c75" } } } @@ -50659,8 +50682,8 @@ }, "relationships": { "properties": { - "states": { - "description": "States/provinces/regions within the country", + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -50668,7 +50691,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" + "example": "/product/deb10517653c255364175796ace3553f/downloads" } } }, @@ -50679,11 +50702,11 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "product_download" }, "id": { "type": "string", - "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } @@ -50691,7 +50714,8 @@ }, "type": "object" }, - "customerAddresses": { + "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -50699,30 +50723,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" + "example": "/product/deb10517653c255364175796ace3553f/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "orderAddresses": { + "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -50730,7 +50753,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" + "example": "/product/deb10517653c255364175796ace3553f/children" } } }, @@ -50741,11 +50764,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "product" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "268184c12df027f536154d099d497b31" } } } @@ -50753,7 +50776,8 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -50761,30 +50785,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" + "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, - "salesChannels": { + "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -50792,30 +50815,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" + "example": "/product/deb10517653c255364175796ace3553f/tax" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, - "taxRules": { + "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -50823,30 +50845,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" + "example": "/product/deb10517653c255364175796ace3553f/manufacturer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax_rule" - }, - "id": { - "type": "string", - "example": "1b93ada511aac379c19d3afcba4e4041" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c2904bca62b22443d6cf5e9d89cab204" } } } }, "type": "object" }, - "currencyCountryRoundings": { + "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -50854,377 +50875,58 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" + "example": "/product/deb10517653c255364175796ace3553f/unit" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency_country_rounding" - }, - "id": { - "type": "string", - "example": "35ef8dd5459bf5f08d44cb278bf07cd4" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "unit" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3e34bdebd9bd5edda27e8728904a2552" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Country": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "addressFormat" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", - "type": "boolean" - }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", - "type": "string" - }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" - }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" - }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" - }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", - "type": "boolean" - }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "companyTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" - }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" - }, - "addressFormat": { - "type": "object" - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_address" - }, - "id": { - "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrderAddresses": { - "properties": { - "links": { - "type": "object", + "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order_address" - }, - "id": { - "type": "string", - "example": "7c55a27217c16d4e6395eb18a7f3be2f" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cover" + } } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "states": { - "description": "States/provinces/regions within the country", - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "orderAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "taxRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" - } - }, - "currencyCountryRoundings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - }, - "type": "object" - }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "countryId", - "shortCode", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of the country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "41d0e299ca1abeb2094852da042165c7" + } + } + } + }, + "type": "object" + }, + "featureSet": { "properties": { "links": { "type": "object", @@ -51232,7 +50934,96 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" + "example": "/product/deb10517653c255364175796ace3553f/featureSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_feature_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "description": "Custom CMS page layout for the product detail page", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "023995a50b56c0de077323e958b2bbcd" + } + } + } + }, + "type": "object" + }, + "prices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/prices" } } }, @@ -51243,11 +51034,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "product_price" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -51255,7 +51046,8 @@ }, "type": "object" }, - "b2bPendingOrderAddresses": { + "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -51263,7 +51055,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" + "example": "/product/deb10517653c255364175796ace3553f/media" } } }, @@ -51274,24 +51066,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order_address" + "example": "product_media" }, "id": { "type": "string", - "example": "7c55a27217c16d4e6395eb18a7f3be2f" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "country": { + }, + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -51299,28 +51087,62 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "example": "89936e14544d1b403cecef938101b6b0" + } + } + } + } + }, + "type": "object" + }, + "crossSellingAssignedProducts": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling_assigned_products" + }, + "id": { + "type": "string", + "example": "5ee26b69e515f51ece26912961283b6d" + } } } } }, "type": "object" }, - "customerAddresses": { + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -51328,7 +51150,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" } } }, @@ -51339,11 +51161,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" + "example": "c0827fee13725d41f1fd7e292243f5aa" } } } @@ -51351,7 +51173,7 @@ }, "type": "object" }, - "orderAddresses": { + "visibilities": { "properties": { "links": { "type": "object", @@ -51359,7 +51181,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" + "example": "/product/deb10517653c255364175796ace3553f/visibilities" } } }, @@ -51370,277 +51192,83 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "product_visibility" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "63226fcdfe3316ec1237ef07a8fe6732" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CountryState": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "countryId", - "shortCode", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of the country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_address" - }, - "id": { - "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrderAddresses": { - "properties": { - "links": { - "type": "object", + "searchKeywords": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "effbcffaacb8111b531f15e6f4c796d1" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order_address" - }, - "id": { - "type": "string", - "example": "7c55a27217c16d4e6395eb18a7f3be2f" + "productReviews": { + "description": "Customer reviews and ratings for the product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } } } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "orderAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - }, - "type": "object" - }, - "CurrencyJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" - }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", - "type": "string" - }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" - }, - "shortName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" - }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" - }, - "customFields": { - "type": "object" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" + }, + "type": "object" }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "subscriptions": { + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -51648,7 +51276,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + "example": "/product/deb10517653c255364175796ace3553f/mainCategories" } } }, @@ -51659,11 +51287,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "main_category" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -51671,7 +51299,8 @@ }, "type": "object" }, - "quotes": { + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -51679,7 +51308,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + "example": "/product/deb10517653c255364175796ace3553f/seoUrls" } } }, @@ -51690,11 +51319,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "seo_url" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } @@ -51702,7 +51331,7 @@ }, "type": "object" }, - "b2bPendingOrders": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -51710,7 +51339,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" } } }, @@ -51721,11 +51350,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "order_line_item" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } @@ -51733,7 +51362,7 @@ }, "type": "object" }, - "budgets": { + "wishlists": { "properties": { "links": { "type": "object", @@ -51741,7 +51370,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + "example": "/product/deb10517653c255364175796ace3553f/wishlists" } } }, @@ -51752,24 +51381,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "customer_wishlist_product" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "salesChannelDefaultAssignments": { + }, + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -51777,7 +51402,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" + "example": "/product/deb10517653c255364175796ace3553f/options" } } }, @@ -51788,11 +51413,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "property_group_option" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "93da65a9fd0004d9477aeac024e08e15" } } } @@ -51800,7 +51425,8 @@ }, "type": "object" }, - "orders": { + "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -51808,7 +51434,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/orders" + "example": "/product/deb10517653c255364175796ace3553f/properties" } } }, @@ -51819,11 +51445,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "property_group_option" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "74693d2fc58b46bd06410f278e39aa71" } } } @@ -51831,7 +51457,8 @@ }, "type": "object" }, - "salesChannels": { + "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -51839,7 +51466,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" + "example": "/product/deb10517653c255364175796ace3553f/categories" } } }, @@ -51850,11 +51477,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "category" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } @@ -51862,7 +51489,8 @@ }, "type": "object" }, - "salesChannelDomains": { + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -51870,7 +51498,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" + "example": "/product/deb10517653c255364175796ace3553f/streams" } } }, @@ -51881,11 +51509,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "product_stream" }, "id": { "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" } } } @@ -51893,7 +51521,8 @@ }, "type": "object" }, - "promotionDiscountPrices": { + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -51901,7 +51530,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" } } }, @@ -51912,11 +51541,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount_prices" + "example": "category" }, "id": { "type": "string", - "example": "325723473ecab76b0f45e1554513f779" + "example": "7f0702d3a90d965b8c9158c451f43fdb" } } } @@ -51924,7 +51553,8 @@ }, "type": "object" }, - "productExports": { + "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -51932,7 +51562,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + "example": "/product/deb10517653c255364175796ace3553f/tags" } } }, @@ -51943,11 +51573,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "tag" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -51955,7 +51585,7 @@ }, "type": "object" }, - "countryRoundings": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -51963,7 +51593,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, @@ -51974,11 +51604,11 @@ "properties": { "type": { "type": "string", - "example": "currency_country_rounding" + "example": "custom_field_set" }, "id": { "type": "string", - "example": "3de4aa80c8c8822ea10d156a6f58d6f7" + "example": "9b29ba872ce510f033b31364c8602760" } } } @@ -51994,16 +51624,14 @@ } ] }, - "Currency": { + "Product": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", + "taxId", + "price", + "productNumber", + "stock", "name" ], "properties": { @@ -52011,83 +51639,325 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "description": "Unique identity of feature set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, - "shortName": { + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", + "type": "integer", + "format": "int64" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" + }, + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" + }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "name": { + "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", + "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" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "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" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", + "purchasePrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true + }, + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", + "type": "boolean" + }, + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaDescription": { + "type": "string" + }, + "name": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "packUnit": { + "type": "string" + }, + "packUnitPlural": { + "type": "string" + }, "customFields": { "type": "object" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "slotConfig": { "type": "object" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string", + "enum": [ + "physical", + "digital" + ] + }, + "states": { + "type": "array", + "items": { + "type": "string" }, - "type": "object" + "readOnly": true, + "deprecated": true }, "createdAt": { "type": "string", @@ -52104,7 +51974,69 @@ }, "extensions": { "properties": { - "subscriptions": { + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" + }, + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroups": { "properties": { "links": { "type": "object", @@ -52112,7 +52044,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" } } }, @@ -52123,11 +52055,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "warehouse_group" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } } @@ -52135,7 +52067,7 @@ }, "type": "object" }, - "quotes": { + "warehouses": { "properties": { "links": { "type": "object", @@ -52143,7 +52075,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + "example": "/product/deb10517653c255364175796ace3553f/warehouses" } } }, @@ -52154,11 +52086,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "product_warehouse" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "544959798565126142ca2820b4f56271" } } } @@ -52166,7 +52098,7 @@ }, "type": "object" }, - "b2bPendingOrders": { + "orderWarehouses": { "properties": { "links": { "type": "object", @@ -52174,7 +52106,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } } }, @@ -52185,11 +52117,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "order_product_warehouse" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "5331369e2f71d048521bd35d80975314" } } } @@ -52197,7 +52129,7 @@ }, "type": "object" }, - "budgets": { + "reviewSummaries": { "properties": { "links": { "type": "object", @@ -52205,7 +52137,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, @@ -52216,706 +52148,552 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "product_review_summary" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "c9c718522e64ffa5effb26cef94f4849" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "orders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "salesChannelDomains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - }, - "promotionDiscountPrices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - }, - "productExports": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - }, - "countryRoundings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - }, - "type": "object" - }, - "CurrencyCountryRoundingJsonApi": { - "description": "Added since version: 6.4.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "search": { "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { + "quoteLineItems": { "properties": { - "currency": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } - }, - "type": "object" + } }, - "country": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" } } - }, - "type": "object" + } } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "CurrencyCountryRounding": { - "description": "Added since version: 6.4.0.0", - "required": [ - "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "country": { - "$ref": "#/components/schemas/Country" - } - }, - "type": "object" - }, - "CustomEntityJsonApi": { - "description": "Added since version: 6.4.9.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "fields" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the entity.", - "type": "string" - }, - "fields": { - "type": "object" - }, - "flags": { - "type": "object" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pluginId": { - "description": "Unique identity of plugin.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "customFieldsAware": { - "description": "Parameter that indicates the areas in which the custom field is supported.", - "type": "boolean" - }, - "labelProperty": { - "description": "Specifies which property or attribute of the custom entity is used.", - "type": "string" - }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - } - ] - }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", - "required": [ - "id", - "name", - "fields" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the entity.", - "type": "string" - }, - "fields": { - "type": "object" - }, - "flags": { - "type": "object" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pluginId": { - "description": "Unique identity of plugin.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "customFieldsAware": { - "description": "Parameter that indicates the areas in which the custom field is supported.", - "type": "boolean" - }, - "labelProperty": { - "description": "Specifies which property or attribute of the custom entity is used.", - "type": "string" - }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "CustomFieldJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of a custom field.", - "type": "string" - }, - "type": { - "description": "Custom field type can be selection, media , etc", - "type": "string" }, - "config": { + "shoppingListLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } + } + } + } + }, "type": "object" }, - "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" + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "d7706d2e11bc4878ffb242403ea5b274" + } + } + } + } + }, + "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" + } + } + } + } + }, + "type": "object", "readOnly": true }, - "extensions": { + "items": { + "description": "Products referenced as bundle items of this bundle.", "properties": { - "advancedSearchConfigFields": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "bdf4d1c41d2b0aa72620e925951c2b0d" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/items" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" } } - }, - "type": "object" + } } }, "type": "object" }, - "relationships": { + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", "properties": { - "customFieldSet": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" - } + } + } + } + }, + "type": "object" + }, + "bundles": { + "description": "Bundles that include this product as an item.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" } } - }, - "type": "object" + } + } + }, + "type": "object" + }, + "employeeWishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + } + } }, - "productSearchConfigFields": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "e91afc4e24376c8b995cece3ce354b4e" + } + } + } + } + }, + "type": "object" + }, + "individualPricingComputedCaches": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricingComputedCaches" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_computed_cache" + }, + "id": { + "type": "string", + "example": "0208611f8e65e3ceffe9b336ea836127" } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_search_config_field" - }, - "id": { - "type": "string", - "example": "ae6a70432f71d6905502769f184399b1" - } - } + } + } + } + }, + "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "CustomField": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of a custom field.", - "type": "string" + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } }, - "type": { - "description": "Custom field type can be selection, media , etc", - "type": "string" + "parent": { + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, - "config": { - "type": "object" + "children": { + "description": "Product variants that inherit from this parent product", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "active": { - "description": "When boolean value is `true`, the custom field is enabled for use.", - "type": "boolean" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, - "customFieldSetId": { - "description": "Unique identity of customFieldSet.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, - "allowCustomerWrite": { - "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", - "type": "boolean" + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, - "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" + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, - "storeApiAware": { - "type": "boolean" + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, - "includeInSearch": { - "type": "boolean" + "featureSet": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" + }, + "canonicalProduct": { + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" + }, + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + }, + "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" + } + }, + "crossSellingAssignedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + }, + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "visibilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + }, + "searchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + }, + "productReviews": { + "description": "Customer reviews and ratings for the product", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "properties": { + "description": "Product properties and characteristics for filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "categories": { + "description": "Categories this product is assigned to", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } }, - "extensions": { - "properties": { - "advancedSearchConfigFields": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "bdf4d1c41d2b0aa72620e925951c2b0d" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "tags": { + "description": "Tags for organizing and filtering products", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "productSearchConfigFields": { + "customFieldSets": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/CustomFieldSet" } } }, "type": "object" }, - "CustomFieldSetJsonApi": { - "description": "Added since version: 6.0.0.0", + "BundleDiscountJsonApi": { + "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -52923,38 +52701,64 @@ { "required": [ "id", - "name" + "bundleId", + "type", + "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of a custom field set.", - "type": "string" + "versionId": { + "description": "Version identifier of the bundle discount entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "bundleId": { + "description": "Bundle product that owns this discount configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Discount calculation type (absolute or percentage).", + "type": "string" }, "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", + "description": "Indicates if the discount is currently active.", "type": "boolean" }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" }, - "appId": { - "description": "Unique identity of an app.", + "currencyId": { + "description": "Currency that an absolute discount value refers to.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "preventCombination": { + "description": "Whether this discount blocks other promotion combinations.", + "type": "boolean" + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -52967,7 +52771,8 @@ }, "relationships": { "properties": { - "customFields": { + "currency": { + "description": "Currency entity linked to the discount.", "properties": { "links": { "type": "object", @@ -52975,61 +52780,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/currency" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field" - }, - "id": { - "type": "string", - "example": "4e252ff73243c27b4df9002e452fc6a7" - } - } - } - } - }, - "type": "object" - }, - "relations": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set_relation" - }, - "id": { - "type": "string", - "example": "06c5b10273a69992d8c6933e294909fa" - } + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "products": { + "rules": { + "description": "Business rules that must match for the discount to apply.", "properties": { "links": { "type": "object", @@ -53037,7 +52810,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/rules" } } }, @@ -53048,46 +52821,17 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "rule" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" - }, - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -53097,42 +52841,72 @@ } ] }, - "CustomFieldSet": { - "description": "Added since version: 6.0.0.0", + "BundleDiscount": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "name" + "type", + "value", + "active", + "preventCombination" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of a custom field set.", - "type": "string" + "versionId": { + "description": "Version identifier of the bundle discount entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "bundleId": { + "description": "Bundle product that owns this discount configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Discount calculation type (absolute or percentage).", + "type": "string", + "enum": [ + "absolute", + "percentage" + ] }, "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", + "description": "Indicates if the discount is currently active.", "type": "boolean" }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" }, - "appId": { - "description": "Unique identity of an app.", + "currencyId": { + "description": "Currency that an absolute discount value refers to.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "preventCombination": { + "description": "Whether this discount blocks other promotion combinations.", + "type": "boolean" + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -53143,143 +52917,63 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - }, - "relations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency entity linked to the discount." }, - "products": { + "rules": { + "description": "Business rules that must match for the discount to apply.", "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Rule" } }, - "app": { - "$ref": "#/components/schemas/App" + "apiAlias": { + "type": "string", + "readOnly": true } }, "type": "object" }, - "CustomFieldSetRelationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "customFieldSetId", - "entityName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { - "description": "Name of the entity.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "customFieldSet": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomFieldSetRelation": { - "description": "Added since version: 6.0.0.0", + "BundleDiscountRule": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "customFieldSetId", - "entityName" + "bundleDiscountId", + "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", + "bundleDiscountId": { + "description": "Identifier of the bundle discount that references the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { - "description": "Name of the entity.", - "type": "string" - }, - "createdAt": { + "bundleDiscountVersionId": { + "description": "Version of the bundle discount for this mapping.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "ruleId": { + "description": "Sales rule that controls the discount visibility.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "bundleDiscount": { + "$ref": "#/components/schemas/BundleDiscount", + "description": "Associated bundle discount entity." + }, + "rule": { + "$ref": "#/components/schemas/Rule", + "description": "Associated rule entity defining eligibility." } }, "type": "object" }, - "CustomPriceJsonApi": { + "BundleItemJsonApi": { + "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -53288,31 +52982,64 @@ "required": [ "id", "productId", - "price" + "bundleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "description": "Version identifier of the bundle item entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "productId": { + "description": "Product that is included as an item in the bundle.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { + "description": "Version identifier of the referenced product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "bundleId": { + "description": "Bundle product that owns this item entry.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerGroupId": { + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "object" + "position": { + "description": "Display order for the item inside the bundle.", + "type": "integer", + "format": "int64" + }, + "quantity": { + "description": "Default quantity that will be added to the cart for this item.", + "type": "integer", + "format": "int64" + }, + "min": { + "description": "Minimum selectable quantity of the item within the bundle.", + "type": "integer", + "format": "int64" + }, + "max": { + "description": "Maximum selectable quantity of the bundle item.", + "type": "integer", + "format": "int64" + }, + "showBundleOnItemPdp": { + "type": "boolean" + }, + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -53326,36 +53053,8 @@ }, "relationships": { "properties": { - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - }, - "customerGroup": { + "product": { + "description": "Association to the product entity for this bundle item.", "properties": { "links": { "type": "object", @@ -53363,7 +53062,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/product" } } }, @@ -53372,19 +53071,20 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "product": { + "bundle": { + "description": "Association to the parent bundle product.", "properties": { "links": { "type": "object", @@ -53392,7 +53092,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/bundle" } } }, @@ -53406,7 +53106,7 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "94377c156735b39dfa4ac607234cb87c" } } } @@ -53419,38 +53119,128 @@ }, "type": "object" } - ] + ] + }, + "BundleItem": { + "description": "Added since version: 6.7.9.0", + "required": [ + "productId", + "quantity", + "min", + "required" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "description": "Version identifier of the bundle item entity.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Product that is included as an item in the bundle.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "description": "Version identifier of the referenced product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "description": "Bundle product that owns this item entry.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Display order for the item inside the bundle.", + "type": "integer", + "format": "int64", + "minimum": 0 + }, + "quantity": { + "description": "Default quantity that will be added to the cart for this item.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "min": { + "description": "Minimum selectable quantity of the item within the bundle.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "max": { + "description": "Maximum selectable quantity of the bundle item.", + "type": "integer", + "format": "int64" + }, + "showBundleOnItemPdp": { + "type": "boolean", + "description": "Show bundle on the product detail page of this bundle item." + }, + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/BundleItemProduct", + "description": "Association to the product entity for this bundle item." + }, + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association to the parent bundle product." + }, + "apiAlias": { + "type": "string", + "readOnly": true + } + }, + "type": "object" }, - "CustomPrice": { + "BundleVisibility": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "productId", - "price" + "bundleId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "bundleId": { + "description": "Bundle product whose visibility is configured.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { + "description": "Version identifier of the bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { + "salesChannelId": { + "description": "Sales channel in which the bundle should be visible.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -53461,19 +53251,18 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel", + "description": "Association to the sales channel entity." }, - "product": { - "$ref": "#/components/schemas/Product" + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association back to the bundle product." } }, "type": "object" }, - "CustomerJsonApi": { + "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -53482,186 +53271,161 @@ { "required": [ "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "description": "Unique identity of customer group.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language.", + "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", + "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", + "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, - "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" + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" + "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 }, - "email": { - "description": "Email ID of the customer.", - "type": "string" + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true }, - "title": { - "description": "Titles or honorifics like Mr, Mrs, etc.", - "type": "string" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", - "type": "string" + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, - "active": { - "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, - "doubleOptInRegistration": { - "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "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" + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" }, - "hash": { - "description": "Customer registration double opt-in hash for confirming the customer account.", + "name": { "type": "string" }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", - "type": "boolean" + "customFields": { + "type": "object" }, - "firstLogin": { - "description": "To capture date and time of customer's first login.", - "type": "string", - "format": "date-time" + "slotConfig": { + "type": "object" }, - "lastLogin": { - "description": "To capture date and time of customer's last login.", + "linkType": { "type": "string", - "format": "date-time" - }, - "birthday": { - "description": "To capture customer's birthday details.", - "type": "string" + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, - "lastOrderDate": { - "description": "Captures last order date.", + "internalLink": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", - "readOnly": true + "externalLink": { + "type": "string" }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", - "readOnly": true + "linkNewTab": { + "type": "boolean" }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", - "readOnly": true + "description": { + "type": "string" }, - "customFields": { - "type": "object" + "metaTitle": { + "type": "string" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", + "metaDescription": { "type": "string" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "keywords": { + "type": "string" }, - "requestedGroupId": { - "description": "Unique identity of requested group.", + "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "boundSalesChannelId": { - "description": "Unique identity of bonus sales channel.", + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -53672,9 +53436,298 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "customPrice": { + "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" + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of category.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "description": "Child categories within this category for hierarchical navigation", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "media": { + "description": "Category image or banner", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "nestedProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "cf73cebf9ade7f94deba94ec71e66e43" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "description": "CMS page layout for the category", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "productStream": { "properties": { "links": { "type": "object", @@ -53682,7 +53735,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "navigationSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" } } }, @@ -53693,11 +53775,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "sales_channel" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "04db458d860e0a4b455ae14b384a5e8a" } } } @@ -53705,7 +53787,7 @@ }, "type": "object" }, - "subscriptionCustomers": { + "footerSalesChannels": { "properties": { "links": { "type": "object", @@ -53713,7 +53795,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" } } }, @@ -53724,11 +53806,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_customer" + "example": "sales_channel" }, "id": { "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" + "example": "57944aba1f6dea7ca9dacf66776e1755" } } } @@ -53736,7 +53818,7 @@ }, "type": "object" }, - "delayActions": { + "serviceSalesChannels": { "properties": { "links": { "type": "object", @@ -53744,7 +53826,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" } } }, @@ -53755,11 +53837,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "sales_channel" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "1a79932fadba3b20baf6369181e45602" } } } @@ -53767,7 +53849,7 @@ }, "type": "object" }, - "employees": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -53775,7 +53857,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" } } }, @@ -53786,11 +53868,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "main_category" }, "id": { "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -53798,7 +53880,8 @@ }, "type": "object" }, - "roles": { + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -53806,7 +53889,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" } } }, @@ -53817,19 +53900,489 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "seo_url" }, "id": { "type": "string", - "example": "4295e8065f2f640103f566df3329e17f" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Category": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" + }, + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "description": "Unique identity of product stream.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "search": { + "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent": { + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." + }, + "children": { + "description": "Child categories within this category for hierarchical navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "media": { + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "nestedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "navigationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "footerSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "serviceSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + }, + "type": "object" + }, + "CategoryTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "categoryId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "CmsBlockJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Unique name of the CMS Block.", + "type": "string" + }, + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" + }, + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" + }, + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" + }, + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" }, - "b2bBusinessPartner": { + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "description": "Unique identity of section.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "section": { "properties": { "links": { "type": "object", @@ -53837,7 +54390,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" } } }, @@ -53846,19 +54399,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_business_partner" + "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" + "example": "73d5342eba070f636ac3246f319bf77f" } } } }, "type": "object" }, - "specificFeatures": { + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -53866,7 +54419,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" } } }, @@ -53875,19 +54428,19 @@ "properties": { "type": { "type": "string", - "example": "customer_specific_features" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" + "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, - "ssoProviderCustomers": { + "slots": { "properties": { "links": { "type": "object", @@ -53895,7 +54448,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" } } }, @@ -53906,19 +54459,218 @@ "properties": { "type": { "type": "string", - "example": "sso_provider_customer" + "example": "cms_slot" }, "id": { "type": "string", - "example": "6f2bd941c85a0835cd1889fd0a2c835a" + "example": "a8b72798beb911ae98c8c8907d45950a" } } } } }, "type": "object" - }, - "quotes": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsBlock": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Unique name of the CMS Block.", + "type": "string" + }, + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" + }, + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" + }, + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" + }, + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "description": "Unique identity of section.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "section": { + "$ref": "#/components/schemas/CmsSection" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "slots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + }, + "type": "object" + }, + "CmsPageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" + }, + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -53926,7 +54678,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" } } }, @@ -53937,11 +54689,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "cms_section" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "ff4dee88db82e98f0e0d524d965b9aa7" } } } @@ -53949,7 +54701,8 @@ }, "type": "object" }, - "quoteComments": { + "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -53957,61 +54710,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" - } - } - } - } - }, - "type": "object" - }, - "organizationUnits": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "4ab85f040b199b758bfb81e383c50b4b" - } + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, - "b2bApprovalRules": { + "categories": { "properties": { "links": { "type": "object", @@ -54019,7 +54739,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" } } }, @@ -54030,11 +54750,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule" + "example": "category" }, "id": { "type": "string", - "example": "545759fb10fcbebd03f04277239baace" + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } @@ -54042,7 +54762,8 @@ }, "type": "object" }, - "b2bPendingOrders": { + "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -54050,7 +54771,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" } } }, @@ -54061,11 +54782,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "landing_page" }, "id": { "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } @@ -54073,7 +54794,7 @@ }, "type": "object" }, - "shoppingLists": { + "homeSalesChannels": { "properties": { "links": { "type": "object", @@ -54081,7 +54802,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" } } }, @@ -54092,11 +54813,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list" + "example": "sales_channel" }, "id": { "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" + "example": "9aed0c38161f67f2d40a4a872cae045f" } } } @@ -54104,7 +54825,7 @@ }, "type": "object" }, - "b2bAdvancedProductCatalogs": { + "products": { "properties": { "links": { "type": "object", @@ -54112,7 +54833,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" } } }, @@ -54123,146 +54844,233 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" + "example": "product" }, "id": { "type": "string", - "example": "912596af64fb66beeb84defb9535e16d" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" + }, + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "homeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "CmsSectionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Name of the CMS section defined.", + "type": "string" + }, + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" + }, + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" + }, + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "pageId": { + "description": "Unique identity of page where CMS section is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" }, - "budgets": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" - } - } - } - } - }, - "type": "object" + "desktop": { + "type": "boolean" }, - "individualPricingCompanyAssignments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" - }, - "id": { - "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" - } - } - } - } - }, - "type": "object" + "tablet": { + "type": "boolean" } }, "type": "object" }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, "relationships": { "properties": { - "group": { - "description": "Customer group determining pricing and permissions", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" - } - } - } - }, - "type": "object" - }, - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "language": { - "description": "Preferred language for customer communication", + "page": { "properties": { "links": { "type": "object", @@ -54270,7 +55078,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" } } }, @@ -54279,20 +55087,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "71860c77c6745379b0d44304d66b6a13" } } } }, "type": "object" }, - "lastPaymentMethod": { - "description": "Last used payment method by the customer", + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -54300,7 +55107,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, @@ -54309,20 +55116,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "bb083200005a374b86f6f5fbbff6f0e0" + "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, - "defaultBillingAddress": { - "description": "Default billing address for the customer", + "blocks": { "properties": { "links": { "type": "object", @@ -54330,29 +55136,221 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "example": "e734964953f880e5164e32827950ff92" + } } } } }, "type": "object" - }, - "activeBillingAddress": { - "description": "Currently active billing address in the session", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSection": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Name of the CMS section defined.", + "type": "string" + }, + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" + }, + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" + }, + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "pageId": { + "description": "Unique identity of page where CMS section is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "page": { + "$ref": "#/components/schemas/CmsPage" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + }, + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" + }, + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "block": { "properties": { "links": { "type": "object", @@ -54360,7 +55358,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, @@ -54369,110 +55367,241 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1a4362407b6a71fa80952dcd4ba7feb3" + "example": "14511f2f5564650d129ca7cabc333278" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" + }, + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "type": "object" + }, + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" + }, + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" }, - "defaultShippingAddress": { - "description": "Default shipping address for the customer", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" - } - } - } - }, - "type": "object" + "currencyId": { + "type": "string" }, - "activeShippingAddress": { - "description": "Currently active shipping address in the session", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f6e2f5dd29b543b8547e30d2d71a6974" - } - } - } - }, - "type": "object" + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" }, - "salutation": { - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" - } - } - } - }, - "type": "object" + "currencyId": { + "type": "string" }, - "addresses": { - "description": "All addresses saved for the customer", + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -54480,7 +55609,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, @@ -54491,11 +55620,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "subscription_address" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -54503,7 +55632,7 @@ }, "type": "object" }, - "orderCustomers": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -54511,7 +55640,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, @@ -54522,11 +55651,11 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -54534,8 +55663,7 @@ }, "type": "object" }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -54543,7 +55671,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, @@ -54554,19 +55682,25 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" - }, - "promotions": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -54574,7 +55708,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, @@ -54585,11 +55719,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "country_state" }, "id": { "type": "string", - "example": "ea6aeb050f871384f25fba9c869cfe21" + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } @@ -54597,7 +55731,7 @@ }, "type": "object" }, - "productReviews": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -54605,7 +55739,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, @@ -54616,11 +55750,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "customer_address" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -54628,36 +55762,7 @@ }, "type": "object" }, - "recoveryCustomer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_recovery" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ce9d8d13e51bf43bc70a4be38950823b" - } - } - } - }, - "type": "object" - }, - "requestedGroup": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -54665,28 +55770,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "46cf25a3f20102ff5e1e17526fb73b62" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } } } } }, "type": "object" }, - "boundSalesChannel": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -54694,28 +55801,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dfe8aec35136b1f62669b388a291a4c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "wishlists": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -54723,7 +55832,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, @@ -54734,11 +55843,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist" + "example": "sales_channel" }, "id": { "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -54746,7 +55855,7 @@ }, "type": "object" }, - "createdBy": { + "taxRules": { "properties": { "links": { "type": "object", @@ -54754,28 +55863,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "1b93ada511aac379c19d3afcba4e4041" + } } } } }, "type": "object" }, - "updatedBy": { + "currencyCountryRoundings": { "properties": { "links": { "type": "object", @@ -54783,21 +55894,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency_country_rounding" + }, + "id": { + "type": "string", + "example": "35ef8dd5459bf5f08d44cb278bf07cd4" + } } } } @@ -54812,189 +55925,130 @@ } ] }, - "Customer": { + "Country": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" + "name", + "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "description": "Unique identity of customer group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "email": { - "description": "Email ID of the customer.", - "type": "string" - }, - "title": { - "description": "Titles or honorifics like Mr, Mrs, etc.", + "name": { "type": "string" }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "type": "string" + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" }, "active": { - "description": "To keep the status of the customer active, the boolean value is set to `true`.", - "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": "Customer registration double opt-in hash for confirming the customer account.", - "type": "string" - }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "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" + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" }, - "birthday": { - "description": "To capture customer's birthday details.", + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, - "lastOrderDate": { - "description": "Captures last order date.", - "type": "string", - "format": "date-time", - "readOnly": true + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", - "readOnly": true + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", - "readOnly": true + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", - "readOnly": true + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } }, - "readOnly": true + "type": "object" }, - "requestedGroupId": { - "description": "Unique identity of requested group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" }, - "boundSalesChannelId": { - "description": "Unique identity of bonus sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -55006,102 +56060,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "customPrice": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } - } - } - } - }, - "type": "object" - }, - "subscriptionCustomers": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_customer" - }, - "id": { - "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" - } - } - } - } - }, - "type": "object" - }, - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "employees": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -55109,7 +56073,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, @@ -55120,11 +56084,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "subscription_address" }, "id": { "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -55132,7 +56096,7 @@ }, "type": "object" }, - "roles": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -55140,7 +56104,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, @@ -55151,11 +56115,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "4295e8065f2f640103f566df3329e17f" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -55163,65 +56127,7 @@ }, "type": "object" }, - "b2bBusinessPartner": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_business_partner" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" - } - } - } - }, - "type": "object" - }, - "specificFeatures": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_specific_features" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" - } - } - } - }, - "type": "object" - }, - "ssoProviderCustomers": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -55229,7 +56135,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, @@ -55240,236 +56146,343 @@ "properties": { "type": { "type": "string", - "example": "sso_provider_customer" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "6f2bd941c85a0835cd1889fd0a2c835a" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" + } + }, + "type": "object" + }, + "states": { + "description": "States/provinces/regions within the country", + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + }, + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "taxRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + }, + "currencyCountryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + }, + "type": "object" + }, + "CountryStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "countryId", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quoteComments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" - } - } - } - } - }, - "type": "object" + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" }, - "organizationUnits": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "4ab85f040b199b758bfb81e383c50b4b" - } - } - } - } - }, - "type": "object" + "name": { + "type": "string" }, - "b2bApprovalRules": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule" - }, - "id": { - "type": "string", - "example": "545759fb10fcbebd03f04277239baace" - } - } - } - } - }, + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "type": "boolean" + }, + "customFields": { "type": "object" }, - "b2bPendingOrders": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "links": { - "type": "object", + "subscriptionCustomerAddresses": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_address" + }, + "id": { + "type": "string", + "example": "8951627da0210d39cc55d1a91ae21b8d" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + "b2bPendingOrderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "7c55a27217c16d4e6395eb18a7f3be2f" + } + } } } - } + }, + "type": "object" } }, "type": "object" }, - "shoppingLists": { + "relationships": { "properties": { - "links": { - "type": "object", + "country": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list" - }, - "id": { - "type": "string", - "example": "efa2c2d016771a1e072e6b05091fb584" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } } } - } - } - }, - "type": "object" - }, - "b2bAdvancedProductCatalogs": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "customerAddresses": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { - "type": "string", - "example": "912596af64fb66beeb84defb9535e16d" + "orderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } } } - } + }, + "type": "object" } }, "type": "object" - }, - "budgets": { + } + }, + "type": "object" + } + ] + }, + "CountryState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "countryId", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -55477,7 +56490,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, @@ -55488,11 +56501,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_budget" + "example": "subscription_address" }, "id": { "type": "string", - "example": "b7d9e68ed31698bcfe971f824ab5fd23" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -55500,7 +56513,7 @@ }, "type": "object" }, - "individualPricingCompanyAssignments": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -55508,7 +56521,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, @@ -55519,11 +56532,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing_company_assignment" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "78fc5e012f88233a08401f2351a299a9" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } @@ -55534,98 +56547,25 @@ }, "type": "object" }, - "group": { - "$ref": "#/components/schemas/CustomerGroup", - "description": "Customer group determining pricing and permissions" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "language": { - "$ref": "#/components/schemas/Language", - "description": "Preferred language for customer communication" - }, - "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Last used payment method by the customer" - }, - "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default billing address for the customer" - }, - "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active billing address in the session" - }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default shipping address for the customer" - }, - "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active shipping address in the session" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation", - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" + "country": { + "$ref": "#/components/schemas/Country" }, - "addresses": { - "description": "All addresses saved for the customer", + "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, - "orderCustomers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "promotions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - }, - "recoveryCustomer": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "requestedGroup": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "boundSalesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "wishlists": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/OrderAddress" } - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" } }, "type": "object" }, - "CustomerAddressJsonApi": { + "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -55634,87 +56574,95 @@ { "required": [ "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of country's state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "zipcode": { - "description": "Postal or zip code of customer's address.", - "type": "string" + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" }, - "city": { - "description": "Name of customer's city.", + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "company": { - "description": "Name of customer's company.", + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, - "street": { - "description": "Name of customer's street.", + "shortName": { "type": "string" }, - "department": { - "description": "Name of customer's department.", + "name": { "type": "string" }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" }, - "phoneNumber": { - "description": "Customer's phone number.", - "type": "string" + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", - "type": "string" + "customFields": { + "type": "object" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "customFields": { + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, "type": "object" }, "createdAt": { @@ -55727,9 +56675,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "organizationCustomerAddresses": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -55737,7 +56688,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, @@ -55748,11 +56699,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization_customer_address" + "example": "subscription" }, "id": { "type": "string", - "example": "ada6a19a929bea8dbec29edb3d68df58" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -55760,7 +56711,7 @@ }, "type": "object" }, - "organizationDefaultShippingAddresses": { + "quotes": { "properties": { "links": { "type": "object", @@ -55768,7 +56719,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, @@ -55779,11 +56730,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "quote" }, "id": { "type": "string", - "example": "789476f40e97708274b7ff68e5dfd729" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -55791,7 +56742,7 @@ }, "type": "object" }, - "organizationDefaultBillingAddresses": { + "bundleDiscounts": { "properties": { "links": { "type": "object", @@ -55799,7 +56750,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/bundleDiscounts" } } }, @@ -55810,24 +56761,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "bundle_discount" }, "id": { "type": "string", - "example": "7b0213487f5e71c973532f6f31740e5a" + "example": "a79712cce6d0182645b519f6add10f77" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customer": { + }, + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -55835,28 +56781,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" + "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } } } } }, "type": "object" }, - "country": { + "budgets": { "properties": { "links": { "type": "object", @@ -55864,28 +56812,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } } } } }, "type": "object" - }, - "countryState": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -55893,28 +56848,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "salutation": { + "orders": { "properties": { "links": { "type": "object", @@ -55922,303 +56879,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerAddress": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of country's state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "zipcode": { - "description": "Postal or zip code of customer's address.", - "type": "string" - }, - "city": { - "description": "Name of customer's city.", - "type": "string" - }, - "company": { - "description": "Name of customer's company.", - "type": "string" - }, - "street": { - "description": "Name of customer's street.", - "type": "string" - }, - "department": { - "description": "Name of customer's department.", - "type": "string" - }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" - }, - "phoneNumber": { - "description": "Customer's phone number.", - "type": "string" - }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", - "type": "string" - }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", - "type": "string" - }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "organizationCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization_customer_address" - }, - "id": { - "type": "string", - "example": "ada6a19a929bea8dbec29edb3d68df58" - } - } - } - } - }, - "type": "object" - }, - "organizationDefaultShippingAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "789476f40e97708274b7ff68e5dfd729" - } - } - } - } - }, - "type": "object" - }, - "organizationDefaultBillingAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "7b0213487f5e71c973532f6f31740e5a" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "CustomerGroupJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "displayGross": { - "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "registrationActive": { - "description": "To enable the registration of partner customer group.", - "type": "boolean" - }, - "registrationTitle": { - "type": "string" - }, - "registrationIntroduction": { - "type": "string" - }, - "registrationOnlyCompanyRegistration": { - "type": "boolean" - }, - "registrationSeoMetaDescription": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "customPrice": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -56226,7 +56910,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, @@ -56237,11 +56921,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "sales_channel" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -56249,7 +56933,7 @@ }, "type": "object" }, - "advancedProductCatalog": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -56257,33 +56941,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ff9540fcefd24264341c5a70314b71be" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customers": { + }, + "promotionDiscountPrices": { "properties": { "links": { "type": "object", @@ -56291,7 +56972,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" + "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" } } }, @@ -56302,11 +56983,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "promotion_discount_prices" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "325723473ecab76b0f45e1554513f779" } } } @@ -56314,7 +56995,7 @@ }, "type": "object" }, - "salesChannels": { + "productExports": { "properties": { "links": { "type": "object", @@ -56322,7 +57003,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" + "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" } } }, @@ -56333,11 +57014,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "product_export" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -56345,7 +57026,7 @@ }, "type": "object" }, - "registrationSalesChannels": { + "countryRoundings": { "properties": { "links": { "type": "object", @@ -56353,7 +57034,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" + "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" } } }, @@ -56364,11 +57045,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "currency_country_rounding" }, "id": { "type": "string", - "example": "ffc8e76c1fe257d563b9d0024a50620b" + "example": "3de4aa80c8c8822ea10d156a6f58d6f7" } } } @@ -56384,10 +57065,16 @@ } ] }, - "CustomerGroup": { + "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", "name" ], "properties": { @@ -56395,31 +57082,83 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "type": "string" + }, + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" + }, + "shortName": { + "type": "string" + }, "name": { "type": "string" }, - "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" + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" }, - "registrationActive": { - "description": "To enable the registration of partner customer group.", + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "registrationTitle": { - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, - "registrationIntroduction": { - "type": "string" + "customFields": { + "type": "object" }, - "registrationOnlyCompanyRegistration": { - "type": "boolean" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "registrationSeoMetaDescription": { - "type": "string" + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, "createdAt": { "type": "string", @@ -56436,7 +57175,7 @@ }, "extensions": { "properties": { - "customPrice": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -56444,7 +57183,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" + "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, @@ -56455,11 +57194,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "subscription" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -56467,7 +57206,7 @@ }, "type": "object" }, - "advancedProductCatalog": { + "quotes": { "properties": { "links": { "type": "object", @@ -56475,21 +57214,116 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "b2b_components_advanced_product_catalogs" - }, - "id": { + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ff9540fcefd24264341c5a70314b71be" + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } } } } @@ -56499,62 +57333,53 @@ }, "type": "object" }, - "customers": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/SalesChannel" } }, - "salesChannels": { + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Order" } }, - "registrationSalesChannels": { + "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } - } - }, - "type": "object" - }, - "CustomerGroupRegistrationSalesChannels": { - "description": "Added since version: 6.3.1.0", - "required": [ - "customerGroupId", - "salesChannelId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "countryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } }, "type": "object" }, - "CustomerRecoveryJsonApi": { - "description": "Added since version: 6.1.0.0", + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -56562,23 +57387,66 @@ { "required": [ "id", - "hash", - "customerId" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "description": "Password hash for customer's account recovery.", - "type": "string" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of the customer.", + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -56591,7 +57459,7 @@ }, "relationships": { "properties": { - "customer": { + "currency": { "properties": { "links": { "type": "object", @@ -56599,7 +57467,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, @@ -56608,12 +57476,41 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } @@ -56628,27 +57525,70 @@ } ] }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "hash", - "customerId" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "description": "Password hash for customer's account recovery.", - "type": "string" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of the customer.", + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -56659,13 +57599,17 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" } }, "type": "object" }, - "CustomerSpecificFeaturesJsonApi": { + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -56673,20 +57617,53 @@ { "required": [ "id", - "customerId", - "features" + "name", + "fields" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "features": { - "type": "object" + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -56697,63 +57674,63 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "relationships": { - "properties": { - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" } ] }, - "CustomerSpecificFeatures": { + "CustomEntity": { + "description": "Added since version: 6.4.9.0", "required": [ "id", - "customerId", - "features" + "name", + "fields" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "features": { - "type": "object" + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -56764,43 +57741,12 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "customer": { - "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "CustomerTag": { + "CustomFieldJsonApi": { "description": "Added since version: 6.0.0.0", - "required": [ - "customerId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "CustomerWishlistJsonApi": { - "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -56808,26 +57754,47 @@ { "required": [ "id", - "customerId", - "salesChannelId" + "name", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of the customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of a custom field.", + "type": "string" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "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}$" }, - "customFields": { - "type": "object" + "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", @@ -56839,9 +57806,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "products": { + "advancedSearchConfigFields": { "properties": { "links": { "type": "object", @@ -56849,7 +57816,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" } } }, @@ -56860,19 +57827,24 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist_product" + "example": "advanced_search_config_field" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" } } } } }, "type": "object" - }, - "customer": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -56880,7 +57852,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, @@ -56889,19 +57861,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, - "salesChannel": { + "productSearchConfigFields": { "properties": { "links": { "type": "object", @@ -56909,21 +57881,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config_field" + }, + "id": { + "type": "string", + "example": "ae6a70432f71d6905502769f184399b1" + } } } } @@ -56938,30 +57912,51 @@ } ] }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", + "CustomField": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "customerId", - "salesChannelId" + "name", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of the customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of a custom field.", + "type": "string" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "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}$" }, - "customFields": { - "type": "object" + "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", @@ -56973,23 +57968,56 @@ "format": "date-time", "readOnly": true }, - "products": { + "extensions": { + "properties": { + "advancedSearchConfigFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/ProductSearchConfigField" } - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "CustomerWishlistProductJsonApi": { - "description": "Added since version: 6.3.4.0", + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -56997,25 +58025,35 @@ { "required": [ "id", - "productId", - "wishlistId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of a custom field set.", + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "wishlistId": { - "description": "Unique identity of the wishlist.", + "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}$" }, @@ -57031,7 +58069,7 @@ }, "relationships": { "properties": { - "wishlist": { + "customFields": { "properties": { "links": { "type": "object", @@ -57039,28 +58077,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field" + }, + "id": { + "type": "string", + "example": "4e252ff73243c27b4df9002e452fc6a7" + } + } + } + } + }, + "type": "object" + }, + "relations": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "customer_wishlist" - }, - "id": { + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set_relation" + }, + "id": { + "type": "string", + "example": "06c5b10273a69992d8c6933e294909fa" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "723edf7c24638ed18d2fa831e647a5cc" + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" }, - "product": { + "app": { "properties": { "links": { "type": "object", @@ -57068,7 +58170,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, @@ -57077,12 +58179,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -57097,29 +58199,39 @@ } ] }, - "CustomerWishlistProduct": { - "description": "Added since version: 6.3.4.0", + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "wishlistId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Unique name of a custom field set.", + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "wishlistId": { - "description": "Unique identity of the wishlist.", + "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}$" }, @@ -57133,16 +58245,31 @@ "format": "date-time", "readOnly": true }, - "wishlist": { - "$ref": "#/components/schemas/CustomerWishlist" + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } }, - "product": { - "$ref": "#/components/schemas/Product" + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "DeliveryTimeJsonApi": { + "CustomFieldSetRelationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -57151,36 +58278,23 @@ { "required": [ "id", - "name", - "min", - "max", - "unit" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "min": { - "description": "Minimum delivery time taken.", - "type": "integer", - "format": "int64" - }, - "max": { - "description": "Maximum delivery time taken.", - "type": "integer", - "format": "int64" + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours.", + "entityName": { + "description": "Name of the entity.", "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -57191,67 +58305,31 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "shippingMethods": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" - } - } - } - } - }, - "type": "object" - }, - "products": { + "customFieldSet": { "properties": { "links": { "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } @@ -57266,40 +58344,27 @@ } ] }, - "DeliveryTime": { + "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "min", - "max", - "unit" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "min": { - "description": "Minimum delivery time taken.", - "type": "integer", - "format": "int64" - }, - "max": { - "description": "Maximum delivery time taken.", - "type": "integer", - "format": "int64" + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours.", + "entityName": { + "description": "Name of the entity.", "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -57310,26 +58375,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "shippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, - "DocumentJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomPriceJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -57337,56 +58389,31 @@ { "required": [ "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" + "productId", + "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFileId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentA11yMediaFileId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" - }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" - }, - "deepLinkCode": { - "type": "string" - }, - "documentNumber": { - "type": "string" - }, - "customFields": { + "price": { "type": "object" }, "createdAt": { @@ -57401,65 +58428,7 @@ }, "relationships": { "properties": { - "documentType": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" - } - } - } - }, - "type": "object" - }, - "order": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" - } - } - } - }, - "type": "object" - }, - "referencedDocument": { + "customer": { "properties": { "links": { "type": "object", @@ -57467,7 +58436,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customer" } } }, @@ -57476,50 +58445,19 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "75c3c346b0ef4f319e71925ce164a9ae" - } - } - } - }, - "type": "object" - }, - "dependentDocuments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document" - }, - "id": { - "type": "string", - "example": "e74b269b7d5f269051463569677da2a0" - } + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "documentMediaFile": { + "customerGroup": { "properties": { "links": { "type": "object", @@ -57527,7 +58465,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" } } }, @@ -57536,19 +58474,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ac7db1e6be481d6422fc63700e08279d" + "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, - "documentA11yMediaFile": { + "product": { "properties": { "links": { "type": "object", @@ -57556,7 +58494,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" } } }, @@ -57565,12 +58503,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0ea973a1104089c9d0f93bdb06c47cab" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -57585,60 +58523,34 @@ } ] }, - "Document": { - "description": "Added since version: 6.0.0.0", + "CustomPrice": { "required": [ "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" + "productId", + "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFileId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentA11yMediaFileId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" - }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" - }, - "deepLinkCode": { - "type": "string" - }, - "documentNumber": { - "type": "string" - }, - "customFields": { + "price": { "type": "object" }, "createdAt": { @@ -57651,31 +58563,19 @@ "format": "date-time", "readOnly": true }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "referencedDocument": { - "$ref": "#/components/schemas/Document" - }, - "dependentDocuments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "customer": { + "$ref": "#/components/schemas/Customer" }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "documentA11yMediaFile": { - "$ref": "#/components/schemas/Media" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "DocumentBaseConfigJsonApi": { + "CustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -57684,63 +58584,199 @@ { "required": [ "id", - "documentTypeId", - "name" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "description": "Unique identity of the document type.", + "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "logoId": { - "description": "Unique identity of the company logo.", + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the document.", + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, - "filenamePrefix": { - "description": "A prefix name added to the file name separated by an underscore.", + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "filenameSuffix": { - "description": "A suffix name added to the file name separated by an underscore.", + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "global": { - "description": "When set to `true`, the document can be used across all sales channels.", + "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" }, - "documentNumber": { - "description": "Unique number associated with every document.", + "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": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, - "config": { - "type": "object" + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" }, - "createdAt": { + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, "customFields": { "type": "object" }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "documentType": { + "customPrice": { "properties": { "links": { "type": "object", @@ -57748,29 +58784,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" + }, + "subscriptionCustomers": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_customer" + }, + "id": { + "type": "string", + "example": "ee8811605866488e8f21308857e1e5a8" + } } } } }, "type": "object" }, - "logo": { - "description": "Logo in the document at the top-right corner.", + "delayActions": { "properties": { "links": { "type": "object", @@ -57778,28 +58846,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } } } } }, "type": "object" }, - "salesChannels": { + "employees": { "properties": { "links": { "type": "object", @@ -57807,7 +58877,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" } } }, @@ -57818,144 +58888,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config_sales_channel" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentBaseConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "description": "Unique identity of the document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "logoId": { - "description": "Unique identity of the company logo.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the document.", - "type": "string" - }, - "filenamePrefix": { - "description": "A prefix name added to the file name separated by an underscore.", - "type": "string" - }, - "filenameSuffix": { - "description": "A suffix name added to the file name separated by an underscore.", - "type": "string" - }, - "global": { - "description": "When set to `true`, the document can be used across all sales channels.", - "type": "boolean" - }, - "documentNumber": { - "description": "Unique number associated with every document.", - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "logo": { - "$ref": "#/components/schemas/Media", - "description": "Logo in the document at the top-right corner." - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - }, - "type": "object" - }, - "DocumentBaseConfigSalesChannelJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "documentBaseConfigId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "description": "Unique identity of document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "documentType": { + }, + "roles": { "properties": { "links": { "type": "object", @@ -57963,28 +58908,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "example": "4295e8065f2f640103f566df3329e17f" + } } } } }, "type": "object" }, - "documentBaseConfig": { + "b2bBusinessPartner": { "properties": { "links": { "type": "object", @@ -57992,7 +58939,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" } } }, @@ -58001,19 +58948,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56e59df02965ebf8eadea49fa0aadd47" + "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, - "salesChannel": { + "specificFeatures": { "properties": { "links": { "type": "object", @@ -58021,7 +58968,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" } } }, @@ -58030,117 +58977,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "customer_specific_features" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentBaseConfigSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentBaseConfigId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "description": "Unique identity of document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "documentBaseConfig": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "DocumentTypeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "technicalName": { - "description": "Technical name of document type.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "quoteDocuments": { + }, + "ssoProviderCustomers": { "properties": { "links": { "type": "object", @@ -58148,7 +58997,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" } } }, @@ -58159,24 +59008,19 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "sso_provider_customer" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "documents": { + }, + "quotes": { "properties": { "links": { "type": "object", @@ -58184,7 +59028,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } } }, @@ -58195,11 +59039,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "quote" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -58207,7 +59051,7 @@ }, "type": "object" }, - "documentBaseConfigs": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -58215,7 +59059,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } } }, @@ -58226,11 +59070,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "quote_comment" }, "id": { "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + "example": "98dec49a83119c512f84645e81ea52d8" } } } @@ -58238,7 +59082,7 @@ }, "type": "object" }, - "documentBaseConfigSalesChannels": { + "organizationUnits": { "properties": { "links": { "type": "object", @@ -58246,7 +59090,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" } } }, @@ -58257,182 +59101,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config_sales_channel" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "9c990fde5b38ff70fc1a07bf84c12a17" + "example": "4ab85f040b199b758bfb81e383c50b4b" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "technicalName": { - "description": "Technical name of document type.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "quoteDocuments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_document" - }, - "id": { - "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - }, - "documentBaseConfigs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - }, - "documentBaseConfigSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - }, - "type": "object" - }, - "FlowJsonApi": { - "description": "Added since version: 6.4.6.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "eventName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the flow.", - "type": "string" - }, - "eventName": { - "description": "Name of the event.", - "type": "string" - }, - "priority": { - "description": "A numerical value to prioritize one of the flows from the list.", - "type": "integer", - "format": "int64" - }, - "invalid": { - "description": "When the boolean value is `true`, the flow is no more available for usage.", - "type": "boolean", - "readOnly": true - }, - "active": { - "description": "When boolean value is `true`, the flow is available for selection.", - "type": "boolean" - }, - "description": { - "description": "A short description of the defined flow.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "appFlowEventId": { - "description": "Unique identity of app flow event.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "delayActions": { + }, + "b2bApprovalRules": { "properties": { "links": { "type": "object", @@ -58440,7 +59121,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" } } }, @@ -58451,24 +59132,19 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "b2b_components_approval_rule" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "545759fb10fcbebd03f04277239baace" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "sequences": { + }, + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -58476,7 +59152,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" } } }, @@ -58487,11 +59163,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "eb6710ddc89dae357ae94ca3974b1e38" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -58499,7 +59175,7 @@ }, "type": "object" }, - "appFlowEvent": { + "shoppingLists": { "properties": { "links": { "type": "object", @@ -58507,209 +59183,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } + } + } + } + }, + "type": "object" + }, + "b2bAdvancedProductCatalogs": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d92d404135abc21e31337d9509cbe62f" + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "912596af64fb66beeb84defb9535e16d" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Flow": { - "description": "Added since version: 6.4.6.0", - "required": [ - "id", - "name", - "eventName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the flow.", - "type": "string" - }, - "eventName": { - "description": "Name of the event.", - "type": "string" - }, - "priority": { - "description": "A numerical value to prioritize one of the flows from the list.", - "type": "integer", - "format": "int64" - }, - "invalid": { - "description": "When the boolean value is `true`, the flow is no more available for usage.", - "type": "boolean", - "readOnly": true - }, - "active": { - "description": "When boolean value is `true`, the flow is available for selection.", - "type": "boolean" - }, - "description": { - "description": "A short description of the defined flow.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "appFlowEventId": { - "description": "Unique identity of app flow event.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "sequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - }, - "appFlowEvent": { - "$ref": "#/components/schemas/AppFlowEvent" - } - }, - "type": "object" - }, - "FlowSequenceJsonApi": { - "description": "Added since version: 6.4.6.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "flowId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "flowId": { - "description": "Unique identity of flow.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionName": { - "description": "Unique name of the action in the flow sequence.", - "type": "string" - }, - "config": { - "type": "object" - }, - "position": { - "description": "The order of the tabs of your defined flow sequence is to be displayed.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "The group to which the flow sequence is visible.", - "type": "integer", - "format": "int64" - }, - "trueCase": { - "type": "boolean" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "delayActions": { + "budgets": { "properties": { "links": { "type": "object", @@ -58717,7 +59245,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" } } }, @@ -58728,11 +59256,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "b2b_components_budget" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "b7d9e68ed31698bcfe971f824ab5fd23" } } } @@ -58740,7 +59268,7 @@ }, "type": "object" }, - "webhookEventLogs": { + "individualPricingCompanyAssignments": { "properties": { "links": { "type": "object", @@ -58748,7 +59276,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" } } }, @@ -58759,11 +59287,11 @@ "properties": { "type": { "type": "string", - "example": "webhook_event_log" + "example": "b2b_components_individual_pricing_company_assignment" }, "id": { "type": "string", - "example": "82557f6f51ca956bee524cede1375331" + "example": "78fc5e012f88233a08401f2351a299a9" } } } @@ -58776,7 +59304,8 @@ }, "relationships": { "properties": { - "flow": { + "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -58784,7 +59313,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" } } }, @@ -58793,19 +59322,19 @@ "properties": { "type": { "type": "string", - "example": "flow" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cff5497121104c2b8e0cb41ed2083a9b" + "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" }, - "rule": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -58813,7 +59342,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" } } }, @@ -58822,20 +59351,261 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "language": { + "description": "Preferred language for customer communication", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "lastPaymentMethod": { + "description": "Last used payment method by the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bb083200005a374b86f6f5fbbff6f0e0" + } + } + } + }, + "type": "object" + }, + "defaultBillingAddress": { + "description": "Default billing address for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" + } + } + } + }, + "type": "object" + }, + "activeBillingAddress": { + "description": "Currently active billing address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, + "defaultShippingAddress": { + "description": "Default shipping address for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" + } + } + } + }, + "type": "object" + }, + "activeShippingAddress": { + "description": "Currently active shipping address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, + "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + }, + "addresses": { + "description": "All addresses saved for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } } } } }, "type": "object" }, - "parent": { - "description": "Unique identity of flow sequence.", + "orderCustomers": { "properties": { "links": { "type": "object", @@ -58843,28 +59613,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } } } } }, "type": "object" }, - "children": { + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -58872,7 +59645,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" } } }, @@ -58883,11 +59656,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "tag" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -58895,7 +59668,7 @@ }, "type": "object" }, - "appFlowAction": { + "promotions": { "properties": { "links": { "type": "object", @@ -58903,308 +59676,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8ba9ae8a60ecf9be421e333b95703a68" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "ea6aeb050f871384f25fba9c869cfe21" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "FlowSequence": { - "description": "Added since version: 6.4.6.0", - "required": [ - "id", - "flowId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "flowId": { - "description": "Unique identity of flow.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionName": { - "description": "Unique name of the action in the flow sequence.", - "type": "string" - }, - "config": { - "type": "object" - }, - "position": { - "description": "The order of the tabs of your defined flow sequence is to be displayed.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "The group to which the flow sequence is visible.", - "type": "integer", - "format": "int64" - }, - "trueCase": { - "type": "boolean" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "webhookEventLogs": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook_event_log" - }, - "id": { - "type": "string", - "example": "82557f6f51ca956bee524cede1375331" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "flow": { - "$ref": "#/components/schemas/Flow" - }, - "rule": { - "$ref": "#/components/schemas/Rule" - }, - "parent": { - "$ref": "#/components/schemas/FlowSequence", - "description": "Unique identity of flow sequence." - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - }, - "appFlowAction": { - "$ref": "#/components/schemas/AppFlowAction" - } - }, - "type": "object" - }, - "FlowTemplateJsonApi": { - "description": "Added since version: 6.4.18.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the flow template.", - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - } - ] - }, - "FlowTemplate": { - "description": "Added since version: 6.4.18.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the flow template.", - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ImportExportFileJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "originalName", - "path", - "expireDate" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalName": { - "description": "Original name of the import-export file.", - "type": "string" - }, - "path": { - "description": "A relative URL to the import-export file.", - "type": "string" - }, - "expireDate": { - "description": "Date and time of import-export file expiry.", - "type": "string", - "format": "date-time" - }, - "size": { - "description": "Size of the import-export file.", - "type": "integer", - "format": "int64" - }, - "accessToken": { - "description": "Secret key to access import-export file.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "log": { + "productReviews": { "properties": { "links": { "type": "object", @@ -59212,156 +59707,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ImportExportFile": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "originalName", - "path", - "expireDate" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalName": { - "description": "Original name of the import-export file.", - "type": "string" - }, - "path": { - "description": "A relative URL to the import-export file.", - "type": "string" - }, - "expireDate": { - "description": "Date and time of import-export file expiry.", - "type": "string", - "format": "date-time" - }, - "size": { - "description": "Size of the import-export file.", - "type": "integer", - "format": "int64" - }, - "accessToken": { - "description": "Secret key to access import-export file.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "log": { - "$ref": "#/components/schemas/ImportExportLog" - } - }, - "type": "object" - }, - "ImportExportLogJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "activity", - "state", - "records", - "config" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "activity": { - "type": "string" - }, - "state": { - "type": "string" - }, - "records": { - "type": "integer", - "format": "int64" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "profileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "invalidRecordsLogId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "username": { - "type": "string" - }, - "profileName": { - "type": "string" - }, - "config": { - "type": "object" - }, - "result": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "user": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "recoveryCustomer": { "properties": { "links": { "type": "object", @@ -59369,7 +59738,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" } } }, @@ -59378,19 +59747,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "customer_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "ce9d8d13e51bf43bc70a4be38950823b" } } } }, "type": "object" }, - "profile": { + "requestedGroup": { "properties": { "links": { "type": "object", @@ -59398,7 +59767,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" } } }, @@ -59407,19 +59776,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_profile" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7d97481b1fe66f4b51db90da7e794d9f" + "example": "46cf25a3f20102ff5e1e17526fb73b62" } } } }, "type": "object" }, - "file": { + "boundSalesChannel": { "properties": { "links": { "type": "object", @@ -59427,7 +59796,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" } } }, @@ -59436,19 +59805,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_file" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8c7dd922ad47494fc02c388e12c00eac" + "example": "dfe8aec35136b1f62669b388a291a4c7" } } } }, "type": "object" }, - "invalidRecordsLog": { + "wishlists": { "properties": { "links": { "type": "object", @@ -59456,7 +59825,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "example": "4ec38c6b2208529c1fadccc7d55d7947" + } + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" } } }, @@ -59465,19 +59865,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "46eeeb74b58b97a6a05494fa0024c998" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "failedImportLog": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -59485,7 +59885,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" } } }, @@ -59494,12 +59894,12 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1d6996fa1560fc40e5faad086b07ad18" + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -59514,524 +59914,602 @@ } ] }, - "ImportExportLog": { + "Customer": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "activity", - "state", - "records", - "config" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "activity": { - "type": "string" + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "state": { - "type": "string" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "records": { - "type": "integer", - "format": "int64" + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "profileId": { + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileId": { + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "invalidRecordsLogId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "username": { + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "profileName": { + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "config": { - "type": "object" + "email": { + "description": "Email ID of the customer.", + "type": "string" }, - "result": { - "type": "object" + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" }, - "createdAt": { + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" + }, + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Customer registration double opt-in hash for confirming the customer account.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "profile": { - "$ref": "#/components/schemas/ImportExportProfile" + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true }, - "file": { - "$ref": "#/components/schemas/ImportExportFile" + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "invalidRecordsLog": { - "$ref": "#/components/schemas/ImportExportLog" + "customFields": { + "type": "object" }, - "failedImportLog": { - "$ref": "#/components/schemas/ImportExportLog" - } - }, - "type": "object" - }, - "ImportExportProfileJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, - { - "required": [ - "id", - "technicalName", - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure" - ], + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "description": "Import-export type can be orders, customers, categories.", - "type": "string" - }, - "systemDefault": { - "description": "When boolean value is true `true`, then its a system default profile.", - "type": "boolean" - }, - "sourceEntity": { - "type": "string" - }, - "fileType": { - "description": "Type of file like PDF.", - "type": "string" - }, - "delimiter": { - "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", - "type": "string" - }, - "enclosure": { - "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", - "type": "string" - }, - "mapping": { + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, "type": "object" }, - "updateBy": { + "subscriptionCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_customer" + }, + "id": { + "type": "string", + "example": "ee8811605866488e8f21308857e1e5a8" + } + } + } + } + }, "type": "object" }, - "config": { + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "employees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } + } + } + } + }, + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "roles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "example": "4295e8065f2f640103f566df3329e17f" + } + } + } + } + }, + "type": "object" }, - "translated": { + "b2bBusinessPartner": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_business_partner" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c1736d678c9ca2f952db2f7894193bf3" + } + } + } + }, "type": "object" }, - "relationships": { + "specificFeatures": { "properties": { - "importExportLogs": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_specific_features" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { - "type": "string", - "example": "e4ca733e3c1da4bff4cd4b6078f2237a" - } - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } - }, - "type": "object" + } } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "ImportExportProfile": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "description": "Import-export type can be orders, customers, categories.", - "type": "string" - }, - "systemDefault": { - "description": "When boolean value is true `true`, then its a system default profile.", - "type": "boolean" - }, - "sourceEntity": { - "type": "string" - }, - "fileType": { - "description": "Type of file like PDF.", - "type": "string" - }, - "delimiter": { - "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", - "type": "string" - }, - "enclosure": { - "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", - "type": "string" - }, - "mapping": { - "type": "object" - }, - "updateBy": { - "type": "object" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "importExportLogs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - }, - "type": "object" - }, - "IntegrationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "label", - "accessKey", - "secretAccessKey" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "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": { + "ssoProviderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } + } + } + } + }, "type": "object" }, - "deletedAt": { - "description": "Date and time when the integration was deleted.", - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { + "quotes": { "properties": { - "createdNotifications": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "notification" - }, - "id": { - "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" } } - }, - "type": "object" + } } }, "type": "object" }, - "relationships": { + "quoteComments": { "properties": { - "app": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } - }, - "type": "object" + } }, - "stateMachineHistoryEntries": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_history" - }, - "id": { - "type": "string", - "example": "c78c7ea361b7def0876b75bd1bd37879" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" } } - }, - "type": "object" - }, - "aclRoles": { + } + } + }, + "type": "object" + }, + "organizationUnits": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "4ab85f040b199b758bfb81e383c50b4b" } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "acl_role" - }, - "id": { - "type": "string", - "example": "e050a8081a3eb1d193c23cf0ef761183" - } - } + } + } + } + }, + "type": "object" + }, + "b2bApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "545759fb10fcbebd03f04277239baace" } } - }, - "type": "object" + } } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "Integration": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "label", - "accessKey", - "secretAccessKey" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "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" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "createdNotifications": { + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { "properties": { "links": { "type": "object", @@ -60039,7 +60517,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" } } }, @@ -60050,419 +60528,206 @@ "properties": { "type": { "type": "string", - "example": "notification" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" + "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "stateMachineHistoryEntries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - }, - "aclRoles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - }, - "type": "object" - }, - "IntegrationRole": { - "description": "Added since version: 6.3.3.0", - "required": [ - "integrationId", - "aclRoleId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "integrationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "integration": { - "$ref": "#/components/schemas/Integration" - }, - "role": { - "$ref": "#/components/schemas/AclRole" - } - }, - "type": "object" - }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "url" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "url": { - "type": "string" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, - "translated": { + "b2bAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "912596af64fb66beeb84defb9535e16d" + } + } + } + } + }, "type": "object" }, - "relationships": { + "budgets": { "properties": { - "tags": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" } - }, - "type": "object" + } }, - "cmsPage": { - "description": "CMS page layout for the landing page", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" } } - }, - "type": "object" - }, - "salesChannels": { + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" } - }, - "type": "object" + } }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", - "required": [ - "id", - "name", - "url" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, - "slotConfig": { - "type": "object" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "metaTitle": { - "type": "string" + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, - "metaDescription": { - "type": "string" + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, - "keywords": { - "type": "string" + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, - "url": { - "type": "string" + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "addresses": { + "description": "All addresses saved for the customer", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "translated": { - "type": "object" + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the landing page" - }, - "salesChannels": { + "promotions": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Promotion" } }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", + "productReviews": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ProductReview" } - } - }, - "type": "object" - }, - "LandingPageSalesChannel": { - "description": "Added since version: 6.4.0.0", - "required": [ - "landingPageId", - "salesChannelId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "landingPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "landingPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "recoveryCustomer": { + "$ref": "#/components/schemas/CustomerRecovery" }, - "landingPage": { - "$ref": "#/components/schemas/LandingPage" + "requestedGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "salesChannel": { + "boundSalesChannel": { "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "LandingPageTag": { - "description": "Added since version: 6.4.0.0", - "required": [ - "landingPageId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "landingPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "landingPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } }, - "landingPage": { - "$ref": "#/components/schemas/LandingPage" + "createdBy": { + "$ref": "#/components/schemas/User" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "updatedBy": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "LanguageJsonApi": { + "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -60471,34 +60736,85 @@ { "required": [ "id", - "localeId", - "name" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "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}$" }, - "localeId": { - "description": "Unique identity of locale.", + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { - "description": "Unique identity of translation code.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "name": { - "description": "Name of the language.", + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "active": { - "type": "boolean" + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" @@ -60515,7 +60831,7 @@ }, "extensions": { "properties": { - "subscriptions": { + "organizationCustomerAddresses": { "properties": { "links": { "type": "object", @@ -60523,7 +60839,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, @@ -60534,11 +60850,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "ada6a19a929bea8dbec29edb3d68df58" } } } @@ -60546,7 +60862,7 @@ }, "type": "object" }, - "mediaAiTagTranslation": { + "organizationDefaultShippingAddresses": { "properties": { "links": { "type": "object", @@ -60554,7 +60870,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" } } }, @@ -60565,11 +60881,11 @@ "properties": { "type": { "type": "string", - "example": "media_ai_tag_translation" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" + "example": "789476f40e97708274b7ff68e5dfd729" } } } @@ -60577,7 +60893,7 @@ }, "type": "object" }, - "quotes": { + "organizationDefaultBillingAddresses": { "properties": { "links": { "type": "object", @@ -60585,7 +60901,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" } } }, @@ -60596,19 +60912,24 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "7b0213487f5e71c973532f6f31740e5a" } } } } }, "type": "object" - }, - "b2bEmployees": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customer": { "properties": { "links": { "type": "object", @@ -60616,129 +60937,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "2193894cca6bb5864b8607f09be77ace" - } - } - } - } - }, - "type": "object" - }, - "advancedSearchSynonyms": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_synonym" - }, - "id": { - "type": "string", - "example": "a139d0125b356216337e8386fca65e22" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "customer" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "b2bAppScriptConditions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule_app_script_condition_translation" - }, - "id": { - "type": "string", - "example": "880f55611c0f2ac1026271d799698c6e" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of language.", + "country": { "properties": { "links": { "type": "object", @@ -60746,7 +60966,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, @@ -60755,20 +60975,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "locale": { - "description": "Locale defining regional settings (date, time, number formats)", + "countryState": { "properties": { "links": { "type": "object", @@ -60776,7 +60995,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" } } }, @@ -60785,20 +61004,19 @@ "properties": { "type": { "type": "string", - "example": "locale" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fb216d9e8791e63c8d12bdc420956839" + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "translationCode": { - "description": "Locale used for translating content", + "salutation": { "properties": { "links": { "type": "object", @@ -60806,7 +61024,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" } } }, @@ -60815,51 +61033,294 @@ "properties": { "type": { "type": "string", - "example": "locale" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ef2035242b8fcb7b61c3a41850e60b3" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" - }, - "children": { - "description": "Child languages inheriting from this parent language", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "description": "Unique identity of customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "organizationCustomerAddresses": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } + } + } + } + }, + "type": "object" + }, + "organizationDefaultShippingAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "789476f40e97708274b7ff68e5dfd729" } } - }, - "type": "object" + } + } + }, + "type": "object" + }, + "organizationDefaultBillingAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" + } + } }, - "salesChannels": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "7b0213487f5e71c973532f6f31740e5a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "CustomerGroupJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "customPrice": { "properties": { "links": { "type": "object", @@ -60867,7 +61328,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -60878,11 +61339,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "custom_price" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } @@ -60890,7 +61351,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "advancedProductCatalog": { "properties": { "links": { "type": "object", @@ -60898,60 +61359,32 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } - } - } - } - }, - "type": "object" - }, - "salesChannelDomains": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel_domain" - }, - "id": { - "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" - } + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ff9540fcefd24264341c5a70314b71be" } } } }, "type": "object" - }, + } + }, + "type": "object" + }, + "relationships": { + "properties": { "customers": { "properties": { "links": { @@ -60960,7 +61393,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, @@ -60983,100 +61416,7 @@ }, "type": "object" }, - "newsletterRecipients": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "newsletter_recipient" - }, - "id": { - "type": "string", - "example": "2217f01dc5cddfd5b60387c39867f58e" - } - } - } - } - }, - "type": "object" - }, - "orders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" - } - } - } - } - }, - "type": "object" - }, - "productSearchKeywords": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_search_keyword" - }, - "id": { - "type": "string", - "example": "ea9cb6522f347c9212c9459d63c645f4" - } - } - } - } - }, - "type": "object" - }, - "productKeywordDictionaries": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -61084,7 +61424,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, @@ -61095,11 +61435,11 @@ "properties": { "type": { "type": "string", - "example": "product_keyword_dictionary" + "example": "sales_channel" }, "id": { "type": "string", - "example": "660e189a383ca4eb148e25eb0df85988" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -61107,7 +61447,7 @@ }, "type": "object" }, - "productReviews": { + "registrationSalesChannels": { "properties": { "links": { "type": "object", @@ -61115,7 +61455,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, @@ -61126,46 +61466,17 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "sales_channel" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "ffc8e76c1fe257d563b9d0024a50620b" } } } } }, "type": "object" - }, - "productSearchConfig": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8d4fbbaa71409309d308e57678de7d7a" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -61175,11 +61486,10 @@ } ] }, - "Language": { + "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "localeId", "name" ], "properties": { @@ -61187,30 +61497,32 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "description": "Unique identity of locale.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationCodeId": { - "description": "Unique identity of translation code.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { - "description": "Name of the language.", "type": "string" }, - "active": { + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -61221,102 +61533,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "subscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, - "type": "object" - }, - "mediaAiTagTranslation": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag_translation" - }, - "id": { - "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" - } - } - } - } - }, - "type": "object" - }, - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - }, - "b2bEmployees": { + "customPrice": { "properties": { "links": { "type": "object", @@ -61324,7 +61546,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -61335,11 +61557,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "custom_price" }, "id": { "type": "string", - "example": "2193894cca6bb5864b8607f09be77ace" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } @@ -61347,7 +61569,7 @@ }, "type": "object" }, - "advancedSearchSynonyms": { + "advancedProductCatalog": { "properties": { "links": { "type": "object", @@ -61355,85 +61577,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_synonym" - }, - "id": { - "type": "string", - "example": "a139d0125b356216337e8386fca65e22" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } - } - } - } - }, - "type": "object" - }, - "b2bAppScriptConditions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_approval_rule_app_script_condition_translation" - }, - "id": { - "type": "string", - "example": "880f55611c0f2ac1026271d799698c6e" - } + "pattern": "^[0-9a-f]{32}$", + "example": "ff9540fcefd24264341c5a70314b71be" } } } @@ -61443,23 +61601,10 @@ }, "type": "object" }, - "parent": { - "$ref": "#/components/schemas/Language", - "description": "Unique identity of language." - }, - "locale": { - "$ref": "#/components/schemas/Locale", - "description": "Locale defining regional settings (date, time, number formats)" - }, - "translationCode": { - "$ref": "#/components/schemas/Locale", - "description": "Locale used for translating content" - }, - "children": { - "description": "Child languages inheriting from this parent language", + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Customer" } }, "salesChannels": { @@ -61468,62 +61613,50 @@ "$ref": "#/components/schemas/SalesChannel" } }, - "salesChannelDefaultAssignments": { + "registrationSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } + } + }, + "type": "object" + }, + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", + "required": [ + "customerGroupId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDomains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - }, - "customers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - }, - "newsletterRecipients": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - }, - "orders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productSearchKeywords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productKeywordDictionaries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "productSearchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "LocaleJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomerRecoveryJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -61531,27 +61664,22 @@ { "required": [ "id", - "code", - "name", - "territory" + "hash", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "description": "Code given to the locale. For example: en-CA.", - "type": "string" - }, - "name": { - "type": "string" - }, - "territory": { + "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, - "customFields": { - "type": "object" + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -61563,12 +61691,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "languages": { + "customer": { "properties": { "links": { "type": "object", @@ -61576,30 +61701,108 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" + "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "example": "f3e334d42863e8250c7d03efefbfd387" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" - }, - "users": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "hash", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "description": "Password hash for customer's account recovery.", + "type": "string" + }, + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + } + }, + "type": "object" + }, + "CustomerSpecificFeaturesJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "features" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "features": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { "properties": { "links": { "type": "object", @@ -61607,23 +61810,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" + "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -61638,30 +61839,22 @@ } ] }, - "Locale": { - "description": "Added since version: 6.0.0.0", + "CustomerSpecificFeatures": { "required": [ "id", - "code", - "name", - "territory" + "customerId", + "features" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "description": "Code given to the locale. For example: en-CA.", - "type": "string" - }, - "name": { - "type": "string" - }, - "territory": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { + "features": { "type": "object" }, "createdAt": { @@ -61674,55 +61867,68 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "customer": { + "$ref": "#/components/schemas/Customer" + } + }, + "type": "object" + }, + "CustomerTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "customerId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "languages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "LogEntryJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlistJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "id" + "id", + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "message": { - "description": "Indicates text or content of a log entry.", - "type": "string" - }, - "level": { - "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", - "type": "integer", - "format": "int64" - }, - "channel": { - "type": "string" + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "context": { - "type": "object" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "extra": { + "customFields": { "type": "object" }, "createdAt": { @@ -61734,38 +61940,129 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist_product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "LogEntry": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", "required": [ - "id" + "id", + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "message": { - "description": "Indicates text or content of a log entry.", - "type": "string" - }, - "level": { - "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", - "type": "integer", - "format": "int64" - }, - "channel": { - "type": "string" + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "context": { - "type": "object" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "extra": { + "customFields": { "type": "object" }, "createdAt": { @@ -61777,12 +62074,24 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "MailHeaderFooterJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -61790,33 +62099,27 @@ { "required": [ "id", - "name" + "productId", + "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "headerHtml": { - "type": "string" - }, - "headerPlain": { - "type": "string" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerHtml": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerPlain": { - "type": "string" + "wishlistId": { + "description": "Unique identity of the wishlist.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -61828,12 +62131,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "wishlist": { "properties": { "links": { "type": "object", @@ -61841,23 +62141,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "723edf7c24638ed18d2fa831e647a5cc" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -61872,37 +62199,31 @@ } ] }, - "MailHeaderFooter": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", "required": [ "id", - "name" + "productId", + "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "headerHtml": { - "type": "string" - }, - "headerPlain": { - "type": "string" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerHtml": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerPlain": { - "type": "string" + "wishlistId": { + "description": "Unique identity of the wishlist.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -61914,19 +62235,16 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "wishlist": { + "$ref": "#/components/schemas/CustomerWishlist" }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "MailTemplateJsonApi": { + "DeliveryTimeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -61935,36 +62253,31 @@ { "required": [ "id", - "mailTemplateTypeId", - "subject", - "contentHtml", - "contentPlain" + "name", + "min", + "max", + "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "systemDefault": { - "type": "boolean" - }, - "senderName": { - "type": "string" - }, - "description": { + "name": { "type": "string" }, - "subject": { - "type": "string" + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" }, - "contentHtml": { - "type": "string" + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" }, - "contentPlain": { + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -61985,7 +62298,7 @@ }, "relationships": { "properties": { - "mailTemplateType": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -61993,28 +62306,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "mail_template_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f4e3707ad46065609def210a855620cd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } } } } }, "type": "object" }, - "media": { + "products": { "properties": { "links": { "type": "object", @@ -62022,7 +62337,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" } } }, @@ -62033,11 +62348,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template_media" + "example": "product" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -62053,40 +62368,35 @@ } ] }, - "MailTemplate": { + "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "mailTemplateTypeId", - "subject", - "contentHtml", - "contentPlain" + "name", + "min", + "max", + "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "systemDefault": { - "type": "boolean" - }, - "senderName": { - "type": "string" - }, - "description": { + "name": { "type": "string" }, - "subject": { - "type": "string" + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" }, - "contentHtml": { - "type": "string" + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" }, - "contentPlain": { + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -62105,57 +62415,22 @@ "translated": { "type": "object" }, - "mailTemplateType": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "media": { + "shippingMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateMedia" + "$ref": "#/components/schemas/ShippingMethod" } - } - }, - "type": "object" - }, - "MailTemplateMedia": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "mailTemplateId", - "languageId", - "mediaId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mailTemplateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "mailTemplate": { - "$ref": "#/components/schemas/MailTemplate" }, - "media": { - "$ref": "#/components/schemas/Media" + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" }, - "MailTemplateTypeJsonApi": { + "DocumentJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -62164,28 +62439,56 @@ { "required": [ "id", - "technicalName", - "name" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Technical name of mail template.", - "type": "string" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "availableEntities": { - "type": "object" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { "type": "object" }, - "templateData": { + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -62198,12 +62501,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "mailTemplates": { + "documentType": { "properties": { "links": { "type": "object", @@ -62211,7 +62511,94 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "referencedDocument": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "75c3c346b0ef4f319e71925ce164a9ae" + } + } + } + }, + "type": "object" + }, + "dependentDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" } } }, @@ -62222,17 +62609,75 @@ "properties": { "type": { "type": "string", - "example": "mail_template" + "example": "document" }, "id": { "type": "string", - "example": "e6f502f7d88de75db45325d22998cf6d" + "example": "e74b269b7d5f269051463569677da2a0" } } } } }, "type": "object" + }, + "documentMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ac7db1e6be481d6422fc63700e08279d" + } + } + } + }, + "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -62242,32 +62687,60 @@ } ] }, - "MailTemplateType": { + "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName", - "name" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Technical name of mail template.", - "type": "string" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "availableEntities": { - "type": "object" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { "type": "object" }, - "templateData": { + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -62280,20 +62753,32 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "mailTemplates": { + "order": { + "$ref": "#/components/schemas/Order" + }, + "referencedDocument": { + "$ref": "#/components/schemas/Document" + }, + "dependentDocuments": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/Document" } + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "MainCategoryJsonApi": { - "description": "Added since version: 6.1.0.0", + "DocumentBaseConfigJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -62301,43 +62786,55 @@ { "required": [ "id", - "productId", - "categoryId", - "salesChannelId" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", + "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { - "description": "Unique identity of the category.", - "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" }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "documentNumber": { + "description": "Unique number associated with every document.", + "type": "string" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "updatedAt": { "type": "string", "format": "date-time", @@ -62345,7 +62842,7 @@ }, "relationships": { "properties": { - "product": { + "documentType": { "properties": { "links": { "type": "object", @@ -62353,7 +62850,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" } } }, @@ -62362,19 +62859,20 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "category": { + "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -62382,7 +62880,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, @@ -62391,19 +62889,19 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c4ef352f74e502ef5e7bc98e6f4e493d" + "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" } } } }, "type": "object" }, - "salesChannel": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -62411,21 +62909,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } } } } @@ -62440,66 +62940,82 @@ } ] }, - "MainCategory": { - "description": "Added since version: 6.1.0.0", + "DocumentBaseConfig": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "categoryId", - "salesChannelId" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", + "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { - "description": "Unique identity of the category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of the document.", + "type": "string" }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" + }, + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" + }, + "documentNumber": { + "description": "Unique number associated with every document.", + "type": "string" + }, + "config": { + "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "category": { - "$ref": "#/components/schemas/Category" + "logo": { + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } }, "type": "object" }, - "MeasurementDisplayUnitJsonApi": { - "description": "Added since version: 6.7.1.0", + "DocumentBaseConfigSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -62507,44 +63023,27 @@ { "required": [ "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementSystemId": { + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "default": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "factor": { - "type": "number", - "format": "float" - }, - "precision": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "documentTypeId": { + "description": "Unique identity of document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -62556,12 +63055,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "measurementSystem": { + "documentType": { "properties": { "links": { "type": "object", @@ -62569,7 +63065,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, @@ -62578,129 +63074,19 @@ "properties": { "type": { "type": "string", - "example": "measurement_system" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c0484ac171c930ce54e78cd2e0d80e5a" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "MeasurementDisplayUnit": { - "description": "Added since version: 6.7.1.0", - "required": [ - "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "measurementSystemId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "default": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "factor": { - "type": "number", - "format": "float" - }, - "precision": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "measurementSystem": { - "$ref": "#/components/schemas/MeasurementSystem" - } - }, - "type": "object" - }, - "MeasurementSystemJsonApi": { - "description": "Added since version: 6.7.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "technicalName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "units": { + }, + "documentBaseConfig": { "properties": { "links": { "type": "object", @@ -62708,23 +63094,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "measurement_display_unit" - }, - "id": { - "type": "string", - "example": "b98b3dfbd27e710e6c3ceeae58770b52" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56e59df02965ebf8eadea49fa0aadd47" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -62739,25 +63152,31 @@ } ] }, - "MeasurementSystem": { - "description": "Added since version: 6.7.1.0", + "DocumentBaseConfigSalesChannel": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "documentTypeId": { + "description": "Unique identity of document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -62769,19 +63188,19 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" - } + "documentBaseConfig": { + "$ref": "#/components/schemas/DocumentBaseConfig" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "MediaJsonApi": { + "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -62789,132 +63208,41 @@ }, { "required": [ - "id" + "id", + "technicalName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "description": "Unique identity of the user", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaFolderId": { - "description": "Unique identity of the media folder.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", - "type": "string" - }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png.", - "type": "string" - }, - "uploadedAt": { - "description": "Date and time at which media was added.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "fileName": { - "description": "Name of the media file uploaded.", - "type": "string" - }, - "fileSize": { - "description": "Size of the file media file uploaded.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaData": { - "type": "object", - "readOnly": true - }, - "mediaType": { - "type": "object", - "readOnly": true - }, - "config": { - "type": "object" - }, - "alt": { - "type": "string" - }, - "title": { - "type": "string" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "path": { - "type": "string" - }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "private": { - "description": "When `true`, the media display is kept private.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "fileHash": { + "name": { "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "themes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "theme" - }, - "id": { - "type": "string", - "example": "fe021943dcda87150f590b3475afaded" - } - } - } - } - }, - "type": "object" - }, - "themeMedia": { + "technicalName": { + "description": "Technical name of document type.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "quoteDocuments": { "properties": { "links": { "type": "object", @@ -62922,7 +63250,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, @@ -62933,48 +63261,24 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "quote_document" }, "id": { "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" - }, - "mediaAiTag": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3c88197809d464216a8c40a8db191b38" - } - } - } - }, - "type": "object" - }, - "ssoProviders": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "documents": { "properties": { "links": { "type": "object", @@ -62982,7 +63286,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, @@ -62993,11 +63297,11 @@ "properties": { "type": { "type": "string", - "example": "sso_provider" + "example": "document" }, "id": { "type": "string", - "example": "520b66891556bf9309da72937c4f1f98" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -63005,7 +63309,7 @@ }, "type": "object" }, - "quoteDocuments": { + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -63013,7 +63317,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" } } }, @@ -63024,11 +63328,11 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "document_base_config" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } @@ -63036,7 +63340,7 @@ }, "type": "object" }, - "quoteLineItems": { + "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", @@ -63044,7 +63348,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" } } }, @@ -63055,55 +63359,182 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "document_base_config_sales_channel" }, "id": { "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } } }, "type": "object" - }, - "spatialObjects": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "description": "Technical name of document type.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "quoteDocuments": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "spatial_scene_object" - }, - "id": { - "type": "string", - "example": "ad6bd8458100c1c7b8a7d1478a4ba188" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } - }, - "type": "object" + } } }, "type": "object" + } + }, + "type": "object" + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + }, + "documentBaseConfigSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + }, + "type": "object" + }, + "FlowJsonApi": { + "description": "Added since version: 6.4.6.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "eventName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow.", + "type": "string" + }, + "eventName": { + "description": "Name of the event.", + "type": "string" + }, + "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", + "type": "integer", + "format": "int64" + }, + "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", + "type": "boolean", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the flow is available for selection.", + "type": "boolean" + }, + "description": { + "description": "A short description of the defined flow.", + "type": "string" + }, + "customFields": { + "type": "object" }, - "relationships": { + "appFlowEventId": { + "description": "Unique identity of app flow event.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { "properties": { - "tags": { + "delayActions": { "properties": { "links": { "type": "object", @@ -63111,7 +63542,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" } } }, @@ -63122,20 +63553,24 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" - }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sequences": { "properties": { "links": { "type": "object", @@ -63143,7 +63578,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" } } }, @@ -63154,11 +63589,11 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "3b8779ba05b8f0aed49650f3ff8beb4b" + "example": "eb6710ddc89dae357ae94ca3974b1e38" } } } @@ -63166,7 +63601,7 @@ }, "type": "object" }, - "user": { + "appFlowEvent": { "properties": { "links": { "type": "object", @@ -63174,7 +63609,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/user" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" } } }, @@ -63183,19 +63618,200 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "app_flow_event" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "d92d404135abc21e31337d9509cbe62f" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Flow": { + "description": "Added since version: 6.4.6.0", + "required": [ + "id", + "name", + "eventName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow.", + "type": "string" + }, + "eventName": { + "description": "Name of the event.", + "type": "string" + }, + "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", + "type": "integer", + "format": "int64" + }, + "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", + "type": "boolean", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the flow is available for selection.", + "type": "boolean" + }, + "description": { + "description": "A short description of the defined flow.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "appFlowEventId": { + "description": "Unique identity of app flow event.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + } + } }, - "categories": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "sequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "appFlowEvent": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "type": "object" + }, + "FlowSequenceJsonApi": { + "description": "Added since version: 6.4.6.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "flowId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "flowId": { + "description": "Unique identity of flow.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "description": "Unique name of the action in the flow sequence.", + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "description": "The group to which the flow sequence is visible.", + "type": "integer", + "format": "int64" + }, + "trueCase": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "delayActions": { "properties": { "links": { "type": "object", @@ -63203,7 +63819,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, @@ -63214,11 +63830,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -63226,7 +63842,7 @@ }, "type": "object" }, - "productManufacturers": { + "webhookEventLogs": { "properties": { "links": { "type": "object", @@ -63234,7 +63850,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, @@ -63245,19 +63861,24 @@ "properties": { "type": { "type": "string", - "example": "product_manufacturer" + "example": "webhook_event_log" }, "id": { "type": "string", - "example": "30e3a0f8868364c06aa4be63426c1c79" + "example": "82557f6f51ca956bee524cede1375331" } } } } }, "type": "object" - }, - "productMedia": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "flow": { "properties": { "links": { "type": "object", @@ -63265,30 +63886,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "example": "2b5e079404830806ea36b6c17438cffd" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, - "productDownloads": { + "rule": { "properties": { "links": { "type": "object", @@ -63296,30 +63915,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_download" - }, - "id": { - "type": "string", - "example": "86db490c1f4f52d155dbdb978b1f45d3" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, - "orderLineItemDownloads": { + "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -63327,30 +63945,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item_download" - }, - "id": { - "type": "string", - "example": "8c0a5ecd281c97a912c27c0237b3848f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "avatarUsers": { + "children": { "properties": { "links": { "type": "object", @@ -63358,7 +63974,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" } } }, @@ -63369,11 +63985,11 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "1fc09529f6c95370eb20b81318ff601f" + "example": "268184c12df027f536154d099d497b31" } } } @@ -63381,7 +63997,7 @@ }, "type": "object" }, - "mediaFolder": { + "appFlowAction": { "properties": { "links": { "type": "object", @@ -63389,7 +64005,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" } } }, @@ -63398,19 +64014,299 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "app_flow_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70605921a592ee735964394f7948773b" + "example": "8ba9ae8a60ecf9be421e333b95703a68" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "FlowSequence": { + "description": "Added since version: 6.4.6.0", + "required": [ + "id", + "flowId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "flowId": { + "description": "Unique identity of flow.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "description": "Unique name of the action in the flow sequence.", + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "description": "The group to which the flow sequence is visible.", + "type": "integer", + "format": "int64" + }, + "trueCase": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" + } + } }, - "propertyGroupOptions": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" + }, + "webhookEventLogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "webhook_event_log" + }, + "id": { + "type": "string", + "example": "82557f6f51ca956bee524cede1375331" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "flow": { + "$ref": "#/components/schemas/Flow" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "parent": { + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "appFlowAction": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "type": "object" + }, + "FlowTemplateJsonApi": { + "description": "Added since version: 6.4.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow template.", + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow template.", + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ImportExportFileJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "originalName", + "path", + "expireDate" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalName": { + "description": "Original name of the import-export file.", + "type": "string" + }, + "path": { + "description": "A relative URL to the import-export file.", + "type": "string" + }, + "expireDate": { + "description": "Date and time of import-export file expiry.", + "type": "string", + "format": "date-time" + }, + "size": { + "description": "Size of the import-export file.", + "type": "integer", + "format": "int64" + }, + "accessToken": { + "description": "Secret key to access import-export file.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "log": { "properties": { "links": { "type": "object", @@ -63418,30 +64314,156 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" + "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "789104e3568fde835b6239b251d4aa07" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" } } } }, "type": "object" - }, - "mailTemplateMedia": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportFile": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "originalName", + "path", + "expireDate" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalName": { + "description": "Original name of the import-export file.", + "type": "string" + }, + "path": { + "description": "A relative URL to the import-export file.", + "type": "string" + }, + "expireDate": { + "description": "Date and time of import-export file expiry.", + "type": "string", + "format": "date-time" + }, + "size": { + "description": "Size of the import-export file.", + "type": "integer", + "format": "int64" + }, + "accessToken": { + "description": "Secret key to access import-export file.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "log": { + "$ref": "#/components/schemas/ImportExportLog" + } + }, + "type": "object" + }, + "ImportExportLogJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "activity", + "state", + "records", + "config" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "profileName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "result": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "user": { "properties": { "links": { "type": "object", @@ -63449,61 +64471,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "mail_template_media" - }, - "id": { - "type": "string", - "example": "9970132c8439a2e630b655812b031459" - } - } - } - } - }, - "type": "object" - }, - "documentBaseConfigs": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_base_config" - }, - "id": { - "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" - } + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, - "shippingMethods": { + "profile": { "properties": { "links": { "type": "object", @@ -63511,61 +64500,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" - } - } - } - } - }, - "type": "object" - }, - "paymentMethods": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + "example": "import_export_profile" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7d97481b1fe66f4b51db90da7e794d9f" } } } }, "type": "object" }, - "productConfiguratorSettings": { + "file": { "properties": { "links": { "type": "object", @@ -63573,30 +64529,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_configurator_setting" - }, - "id": { - "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c7dd922ad47494fc02c388e12c00eac" } } } }, "type": "object" }, - "orderLineItems": { + "invalidRecordsLog": { "properties": { "links": { "type": "object", @@ -63604,30 +64558,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "46eeeb74b58b97a6a05494fa0024c998" } } } }, "type": "object" }, - "cmsBlocks": { + "failedImportLog": { "properties": { "links": { "type": "object", @@ -63635,30 +64587,190 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1d6996fa1560fc40e5faad086b07ad18" } } } }, "type": "object" - }, - "cmsSections": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportLog": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "activity", + "state", + "records", + "config" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "profileName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "result": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "profile": { + "$ref": "#/components/schemas/ImportExportProfile" + }, + "file": { + "$ref": "#/components/schemas/ImportExportFile" + }, + "invalidRecordsLog": { + "$ref": "#/components/schemas/ImportExportLog" + }, + "failedImportLog": { + "$ref": "#/components/schemas/ImportExportLog" + } + }, + "type": "object" + }, + "ImportExportProfileJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "label": { + "type": "string" + }, + "type": { + "description": "Import-export type can be orders, customers, categories.", + "type": "string" + }, + "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "description": "Type of file like PDF.", + "type": "string" + }, + "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", + "type": "string" + }, + "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", + "type": "string" + }, + "mapping": { + "type": "object" + }, + "updateBy": { + "type": "object" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "importExportLogs": { "properties": { "links": { "type": "object", @@ -63666,7 +64778,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" + "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" } } }, @@ -63677,19 +64789,162 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "import_export_log" }, "id": { "type": "string", - "example": "53be3cc1c4a8f41af67a90cf9fd09194" + "example": "e4ca733e3c1da4bff4cd4b6078f2237a" } } } } }, "type": "object" - }, - "cmsPages": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportProfile": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "label": { + "type": "string" + }, + "type": { + "description": "Import-export type can be orders, customers, categories.", + "type": "string" + }, + "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "description": "Type of file like PDF.", + "type": "string" + }, + "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", + "type": "string" + }, + "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", + "type": "string" + }, + "mapping": { + "type": "object" + }, + "updateBy": { + "type": "object" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "importExportLogs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + }, + "type": "object" + }, + "IntegrationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "label", + "accessKey", + "secretAccessKey" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "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" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -63697,7 +64952,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, @@ -63708,19 +64963,24 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "notification" }, "id": { "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" + "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" - }, - "documents": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "app": { "properties": { "links": { "type": "object", @@ -63728,61 +64988,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document" - }, - "id": { - "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" - } - } - } - } - }, - "type": "object" - }, - "a11yDocuments": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "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" - } + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "appPaymentMethods": { + "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", @@ -63790,7 +65017,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" } } }, @@ -63801,11 +65028,11 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "state_machine_history" }, "id": { "type": "string", - "example": "e53c737d351047e64a02b7a2a4caffe3" + "example": "c78c7ea361b7def0876b75bd1bd37879" } } } @@ -63813,7 +65040,7 @@ }, "type": "object" }, - "appShippingMethods": { + "aclRoles": { "properties": { "links": { "type": "object", @@ -63821,7 +65048,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" } } }, @@ -63832,11 +65059,11 @@ "properties": { "type": { "type": "string", - "example": "app_shipping_method" + "example": "acl_role" }, "id": { "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" + "example": "e050a8081a3eb1d193c23cf0ef761183" } } } @@ -63852,87 +65079,47 @@ } ] }, - "Media": { + "Integration": { "description": "Added since version: 6.0.0.0", "required": [ - "id" + "id", + "label", + "accessKey", + "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "description": "Unique identity of the user", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaFolderId": { - "description": "Unique identity of the media folder.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", - "type": "string" - }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png.", - "type": "string" - }, - "uploadedAt": { - "description": "Date and time at which media was added.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "fileName": { - "description": "Name of the media file uploaded.", - "type": "string" - }, - "fileSize": { - "description": "Size of the file media file uploaded.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaData": { - "type": "object", - "readOnly": true - }, - "mediaType": { - "type": "object", - "readOnly": true - }, - "config": { - "type": "object" - }, - "alt": { - "type": "string" - }, - "title": { + "label": { + "description": "Label given to Integration.", "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "accessKey": { + "description": "Access key to store api.", "type": "string" }, - "path": { + "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "lastUsageAt": { + "description": "Date and time when teh integration was last used.", + "type": "string", + "format": "date-time" }, - "private": { - "description": "When `true`, the media display is kept private.", + "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, - "fileHash": { - "type": "string" + "deletedAt": { + "description": "Date and time when the integration was deleted.", + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -63944,196 +65131,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "themes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "theme" - }, - "id": { - "type": "string", - "example": "fe021943dcda87150f590b3475afaded" - } - } - } - } - }, - "type": "object" - }, - "themeMedia": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "theme" - }, - "id": { - "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" - } - } - } - } - }, - "type": "object" - }, - "mediaAiTag": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3c88197809d464216a8c40a8db191b38" - } - } - } - }, - "type": "object" - }, - "ssoProviders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sso_provider" - }, - "id": { - "type": "string", - "example": "520b66891556bf9309da72937c4f1f98" - } - } - } - } - }, - "type": "object" - }, - "quoteDocuments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_document" - }, - "id": { - "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" - } - } - } - } - }, - "type": "object" - }, - "quoteLineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } - } - } - } - }, - "type": "object" - }, - "spatialObjects": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -64141,7 +65141,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, @@ -64152,11 +65152,11 @@ "properties": { "type": { "type": "string", - "example": "spatial_scene_object" + "example": "notification" }, "id": { "type": "string", - "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + "example": "04f88ea12127fe03b65beffbc2c96954" } } } @@ -64167,149 +65167,54 @@ }, "type": "object" }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "productManufacturers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - }, - "productMedia": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - }, - "productDownloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - }, - "orderLineItemDownloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - }, - "avatarUsers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - }, - "mediaFolder": { - "$ref": "#/components/schemas/MediaFolder" - }, - "propertyGroupOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "mailTemplateMedia": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateMedia" - } - }, - "documentBaseConfigs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - }, - "shippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - }, - "productConfiguratorSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - }, - "cmsSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } + "app": { + "$ref": "#/components/schemas/App" }, - "cmsPages": { + "stateMachineHistoryEntries": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/StateMachineHistory" } }, - "documents": { + "aclRoles": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/AclRole" } + } + }, + "type": "object" + }, + "IntegrationRole": { + "description": "Added since version: 6.3.3.0", + "required": [ + "integrationId", + "aclRoleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "a11yDocuments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appPaymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "role": { + "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, - "MediaAiTagJsonApi": { + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -64317,31 +65222,49 @@ { "required": [ "id", - "mediaId" + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "active": { + "type": "boolean" }, - "errorCode": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -64358,7 +65281,7 @@ }, "relationships": { "properties": { - "media": { + "tags": { "properties": { "links": { "type": "object", @@ -64366,7 +65289,39 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "description": "CMS page layout for the landing page", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" } } }, @@ -64375,12 +65330,75 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } } } } @@ -64395,34 +65413,53 @@ } ] }, - "MediaAiTag": { + "LandingPage": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "mediaId" + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "active": { + "type": "boolean" }, - "errorCode": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -64437,13 +65474,97 @@ "translated": { "type": "object" }, - "media": { - "$ref": "#/components/schemas/Media" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } } }, "type": "object" }, - "MediaDefaultFolderJsonApi": { + "LandingPageSalesChannel": { + "description": "Added since version: 6.4.0.0", + "required": [ + "landingPageId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPage": { + "$ref": "#/components/schemas/LandingPage" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "LandingPageTag": { + "description": "Added since version: 6.4.0.0", + "required": [ + "landingPageId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPage": { + "$ref": "#/components/schemas/LandingPage" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "LanguageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -64452,33 +65573,274 @@ { "required": [ "id", - "entity" + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "Indicates in which particular entity.", + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "description": "Unique identity of locale.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationCodeId": { + "description": "Unique identity of translation code.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" + }, + "mediaAiTagTranslation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag_translation" + }, + "id": { + "type": "string", + "example": "e78da60cc3106508ef465909fa4cb138" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "b2bEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "2193894cca6bb5864b8607f09be77ace" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchSynonyms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_synonym" + }, + "id": { + "type": "string", + "example": "a139d0125b356216337e8386fca65e22" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "b2bAppScriptConditions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule_app_script_condition_translation" + }, + "id": { + "type": "string", + "example": "880f55611c0f2ac1026271d799698c6e" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "folder": { + "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -64486,7 +65848,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, @@ -64495,126 +65857,20 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "851148b4fd8fd7ae74bd9100c5c0c898" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "entity" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "description": "Indicates in which particular entity.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "folder": { - "$ref": "#/components/schemas/MediaFolder" - } - }, - "type": "object" - }, - "MediaFolderJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "configurationId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "useParentConfiguration": { - "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", - "type": "boolean" - }, - "configurationId": { - "description": "Unique identity of configuration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultFolderId": { - "description": "Unique identity of default folder.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the media folder.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of media folder.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of media folder.", + }, + "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -64622,7 +65878,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, @@ -64631,12 +65887,42 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "fb216d9e8791e63c8d12bdc420956839" + } + } + } + }, + "type": "object" + }, + "translationCode": { + "description": "Locale used for translating content", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ef2035242b8fcb7b61c3a41850e60b3" } } } @@ -64644,6 +65930,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -64651,7 +65938,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" } } }, @@ -64662,7 +65949,7 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "language" }, "id": { "type": "string", @@ -64674,7 +65961,7 @@ }, "type": "object" }, - "media": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -64682,7 +65969,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" } } }, @@ -64693,11 +65980,11 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "sales_channel" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -64705,7 +65992,7 @@ }, "type": "object" }, - "defaultFolder": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -64713,28 +66000,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDomains": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "media_default_folder" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "251dcc9b1621d34e6b01ee14c26b3027" + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } } } } }, "type": "object" }, - "configuration": { + "customers": { "properties": { "links": { "type": "object", @@ -64742,168 +66062,123 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "newsletterRecipients": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "media_folder_configuration" - }, - "id": { + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ccd1066343c95877b75b79d47c36bebe" + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "MediaFolder": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "configurationId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "useParentConfiguration": { - "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", - "type": "boolean" - }, - "configurationId": { - "description": "Unique identity of configuration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultFolderId": { - "description": "Unique identity of default folder.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the media folder.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of media folder.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "parent": { - "$ref": "#/components/schemas/MediaFolder", - "description": "Unique identity of media folder." - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - }, - "defaultFolder": { - "$ref": "#/components/schemas/MediaDefaultFolder" - }, - "configuration": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - }, - "type": "object" - }, - "MediaFolderConfigurationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createThumbnails": { - "description": "When boolean value is `true`, it enables thumbnail creation automatically.", - "type": "boolean" - }, - "keepAspectRatio": { - "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", - "type": "boolean" - }, - "thumbnailQuality": { - "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", - "type": "integer", - "format": "int64" - }, - "private": { - "description": "When boolean value is `true`, the folder contents are restricted from public access.", - "type": "boolean" - }, - "noAssociation": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "mediaFolders": { + }, + "productSearchKeywords": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "ea9cb6522f347c9212c9459d63c645f4" + } + } + } + } + }, + "type": "object" + }, + "productKeywordDictionaries": { "properties": { "links": { "type": "object", @@ -64911,7 +66186,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" } } }, @@ -64922,11 +66197,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "product_keyword_dictionary" }, "id": { "type": "string", - "example": "6e8238687513bde2e85821c839c597c6" + "example": "660e189a383ca4eb148e25eb0df85988" } } } @@ -64934,7 +66209,7 @@ }, "type": "object" }, - "mediaThumbnailSizes": { + "productReviews": { "properties": { "links": { "type": "object", @@ -64942,7 +66217,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" } } }, @@ -64953,17 +66228,46 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail_size" + "example": "product_review" }, "id": { "type": "string", - "example": "44dee48a0006e8db2fcec2a5e1456449" + "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" + }, + "productSearchConfig": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d4fbbaa71409309d308e57678de7d7a" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -64973,34 +66277,37 @@ } ] }, - "MediaFolderConfiguration": { + "Language": { "description": "Added since version: 6.0.0.0", "required": [ - "id" + "id", + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createThumbnails": { - "description": "When boolean value is `true`, it enables thumbnail creation automatically.", - "type": "boolean" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "keepAspectRatio": { - "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", - "type": "boolean" + "localeId": { + "description": "Unique identity of locale.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "thumbnailQuality": { - "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", - "type": "integer", - "format": "int64" + "translationCodeId": { + "description": "Unique identity of translation code.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "private": { - "description": "When boolean value is `true`, the folder contents are restricted from public access.", - "type": "boolean" + "name": { + "description": "Name of the language.", + "type": "string" }, - "noAssociation": { + "active": { "type": "boolean" }, "customFields": { @@ -65016,268 +66323,308 @@ "format": "date-time", "readOnly": true }, - "mediaFolders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - }, - "mediaThumbnailSizes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - }, - "type": "object" - }, - "MediaFolderConfigurationMediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", - "required": [ - "mediaFolderConfigurationId", - "mediaThumbnailSizeId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaFolderConfigurationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaThumbnailSizeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaFolderConfiguration": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - }, - "mediaThumbnailSize": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - }, - "type": "object" - }, - "MediaTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "mediaId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "MediaThumbnailJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "mediaId", - "width", - "height" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaThumbnailSizeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "url": { - "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "path": { - "type": "string" - }, - "customFields": { + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "mediaAiTagTranslation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag_translation" + }, + "id": { + "type": "string", + "example": "e78da60cc3106508ef465909fa4cb138" + } + } + } + } + }, + "type": "object" }, - "relationships": { + "quotes": { "properties": { - "media": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } + } + } + } + }, + "type": "object" + }, + "b2bEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "2193894cca6bb5864b8607f09be77ace" } } - }, - "type": "object" + } + } + }, + "type": "object" + }, + "advancedSearchSynonyms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" + } + } }, - "mediaThumbnailSize": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_synonym" + }, + "id": { + "type": "string", + "example": "a139d0125b356216337e8386fca65e22" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_thumbnail_size" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0d0b8659a3a47e9d7e1481961f127fd0" - } + } + } + } + }, + "type": "object" + }, + "b2bAppScriptConditions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule_app_script_condition_translation" + }, + "id": { + "type": "string", + "example": "880f55611c0f2ac1026271d799698c6e" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "MediaThumbnail": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "mediaId", - "width", - "height" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, - "mediaThumbnailSizeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" + }, + "translationCode": { + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" + }, + "children": { + "description": "Child languages inheriting from this parent language", + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } }, - "url": { - "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", - "type": "string" + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } }, - "path": { - "type": "string" + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } }, - "customFields": { - "type": "object" + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "productSearchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "productKeywordDictionaries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } }, - "media": { - "$ref": "#/components/schemas/Media" + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } }, - "mediaThumbnailSize": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "productSearchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" } }, "type": "object" }, - "MediaThumbnailSizeJsonApi": { + "LocaleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -65286,23 +66633,24 @@ { "required": [ "id", - "width", - "height" + "code", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64" + "code": { + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64" + "name": { + "type": "string" + }, + "territory": { + "type": "string" }, "customFields": { "type": "object" @@ -65317,9 +66665,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "mediaFolderConfigurations": { + "languages": { "properties": { "links": { "type": "object", @@ -65327,7 +66678,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" } } }, @@ -65338,11 +66689,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder_configuration" + "example": "language" }, "id": { "type": "string", - "example": "056df7a700173d83ebb685b1a890f09b" + "example": "f3e334d42863e8250c7d03efefbfd387" } } } @@ -65350,7 +66701,7 @@ }, "type": "object" }, - "mediaThumbnails": { + "users": { "properties": { "links": { "type": "object", @@ -65358,7 +66709,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" } } }, @@ -65369,11 +66720,11 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "user" }, "id": { "type": "string", - "example": "76ebc340ac8f9754c760c3ec742d2407" + "example": "9bc65c2abec141778ffaa729489f3e87" } } } @@ -65389,27 +66740,28 @@ } ] }, - "MediaThumbnailSize": { + "Locale": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "width", - "height" + "code", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64" + "code": { + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64" + "name": { + "type": "string" + }, + "territory": { + "type": "string" }, "customFields": { "type": "object" @@ -65424,22 +66776,25 @@ "format": "date-time", "readOnly": true }, - "mediaFolderConfigurations": { + "translated": { + "type": "object" + }, + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/Language" } }, - "mediaThumbnails": { + "users": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/User" } } }, "type": "object" }, - "NewsletterRecipientJsonApi": { + "LogEntryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -65447,82 +66802,123 @@ }, { "required": [ - "id", - "email", - "status", - "hash", - "languageId", - "salesChannelId" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "email": { - "description": "Email of the recipient.", - "type": "string" - }, - "title": { - "description": "Title of the recipient's newsletter.", + "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, - "firstName": { - "description": "First name of the recipient.", - "type": "string" + "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", + "type": "integer", + "format": "int64" }, - "lastName": { - "description": "Last name of the recipient.", + "channel": { "type": "string" }, - "zipCode": { - "description": "Zipcode of the recipient's address.", - "type": "string" + "context": { + "type": "object" }, - "city": { - "description": "City of the recipient.", - "type": "string" + "extra": { + "type": "object" }, - "street": { - "description": "Street of the recipient.", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "status": { - "description": "When status is set, the NewsletterRecipient is made visible.", + "updatedAt": { "type": "string", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct" - ] + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "LogEntry": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "message": { + "description": "Indicates text or content of a log entry.", + "type": "string" + }, + "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", + "type": "integer", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "context": { + "type": "object" + }, + "extra": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "MailHeaderFooterJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "description": "Password hash for account recovery.", + "systemDefault": { + "type": "boolean" + }, + "name": { "type": "string" }, - "customFields": { - "type": "object" + "description": { + "type": "string" }, - "confirmedAt": { - "description": "Date and time when the Newsletter was received.", - "type": "string", - "format": "date-time" + "headerHtml": { + "type": "string" }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "headerPlain": { + "type": "string" }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "footerHtml": { + "type": "string" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "footerPlain": { + "type": "string" }, "createdAt": { "type": "string", @@ -65534,9 +66930,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "tags": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -65544,7 +66943,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" + "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, @@ -65555,104 +66954,17 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "sales_channel" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" - }, - "salutation": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" - } - } - } - }, - "type": "object" - }, - "language": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" - } - } - } - }, - "type": "object" - }, - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -65662,86 +66974,38 @@ } ] }, - "NewsletterRecipient": { + "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "email", - "status", - "hash", - "languageId", - "salesChannelId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "email": { - "description": "Email of the recipient.", - "type": "string" - }, - "title": { - "description": "Title of the recipient's newsletter.", - "type": "string" + "systemDefault": { + "type": "boolean" }, - "firstName": { - "description": "First name of the recipient.", + "name": { "type": "string" }, - "lastName": { - "description": "Last name of the recipient.", + "description": { "type": "string" }, - "zipCode": { - "description": "Zipcode of the recipient's address.", + "headerHtml": { "type": "string" }, - "city": { - "description": "City of the recipient.", + "headerPlain": { "type": "string" }, - "street": { - "description": "Street of the recipient.", + "footerHtml": { "type": "string" }, - "status": { - "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct" - ] - }, - "hash": { - "description": "Password hash for account recovery.", + "footerPlain": { "type": "string" }, - "customFields": { - "type": "object" - }, - "confirmedAt": { - "description": "Date and time when the Newsletter was received.", - "type": "string", - "format": "date-time" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -65752,54 +67016,20 @@ "format": "date-time", "readOnly": true }, - "tags": { + "translated": { + "type": "object" + }, + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SalesChannel" } - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "NewsletterRecipientTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "newsletterRecipientId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "newsletterRecipientId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "newsletterRecipient": { - "$ref": "#/components/schemas/NewsletterRecipient" - }, - "tag": { - "$ref": "#/components/schemas/Tag" } }, "type": "object" - }, - "NotificationJsonApi": { - "description": "Added since version: 6.4.7.0", + }, + "MailTemplateJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -65807,42 +67037,40 @@ { "required": [ "id", - "status", - "message" + "mailTemplateTypeId", + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "status": { - "description": "When status is set, the Notification is made visible.", + "mailTemplateTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "senderName": { "type": "string" }, - "message": { - "description": "Indicates text or content of a notification message.", + "description": { "type": "string" }, - "adminOnly": { - "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", - "type": "boolean" + "subject": { + "type": "string" }, - "requiredPrivileges": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "contentHtml": { + "type": "string" }, - "createdByIntegrationId": { - "description": "Unique identity of createdByIntegration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "contentPlain": { + "type": "string" }, - "createdByUserId": { - "description": "Unique identity of createdByUser.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -65854,9 +67082,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "createdByIntegration": { + "mailTemplateType": { "properties": { "links": { "type": "object", @@ -65864,7 +67095,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, @@ -65873,19 +67104,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "mail_template_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "4698501400b26be8a41def09646e1b59" + "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, - "createdByUser": { + "media": { "properties": { "links": { "type": "object", @@ -65893,21 +67124,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8a66af2fd5b68899934d19e078c9c111" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } } } } @@ -65922,46 +67155,44 @@ } ] }, - "Notification": { - "description": "Added since version: 6.4.7.0", + "MailTemplate": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "status", - "message" + "mailTemplateTypeId", + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "status": { - "description": "When status is set, the Notification is made visible.", + "mailTemplateTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "senderName": { "type": "string" }, - "message": { - "description": "Indicates text or content of a notification message.", + "description": { "type": "string" }, - "adminOnly": { - "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", - "type": "boolean" + "subject": { + "type": "string" }, - "requiredPrivileges": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "contentHtml": { + "type": "string" }, - "createdByIntegrationId": { - "description": "Unique identity of createdByIntegration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "contentPlain": { + "type": "string" }, - "createdByUserId": { - "description": "Unique identity of createdByUser.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -65973,16 +67204,60 @@ "format": "date-time", "readOnly": true }, - "createdByIntegration": { - "$ref": "#/components/schemas/Integration" + "translated": { + "type": "object" }, - "createdByUser": { - "$ref": "#/components/schemas/User" + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } } }, "type": "object" }, - "NumberRangeJsonApi": { + "MailTemplateMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mailTemplateId", + "languageId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailTemplateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "mailTemplate": { + "$ref": "#/components/schemas/MailTemplate" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MailTemplateTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -65991,10 +67266,7 @@ { "required": [ "id", - "typeId", - "global", - "pattern", - "start", + "technicalName", "name" ], "properties": { @@ -66002,33 +67274,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "typeId": { - "description": "Unique identity of type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "global": { - "description": "When set to `true`, the defined number range is used across all sales channels.", - "type": "boolean" - }, "name": { "type": "string" }, - "description": { - "type": "string" - }, - "pattern": { - "description": "Custom formatting in order to include for example, the date in the number range.", + "technicalName": { + "description": "Technical name of mail template.", "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" + "availableEntities": { + "type": "object" }, "customFields": { "type": "object" }, + "templateData": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -66044,36 +67305,7 @@ }, "relationships": { "properties": { - "type": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" - } - } - } - }, - "type": "object" - }, - "numberRangeSalesChannels": { + "mailTemplates": { "properties": { "links": { "type": "object", @@ -66081,7 +67313,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" + "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" } } }, @@ -66092,46 +67324,17 @@ "properties": { "type": { "type": "string", - "example": "number_range_sales_channel" + "example": "mail_template" }, "id": { "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" + "example": "e6f502f7d88de75db45325d22998cf6d" } } } } }, "type": "object" - }, - "state": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -66141,14 +67344,11 @@ } ] }, - "NumberRange": { + "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "typeId", - "global", - "pattern", - "start", + "technicalName", "name" ], "properties": { @@ -66156,33 +67356,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "typeId": { - "description": "Unique identity of type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "global": { - "description": "When set to `true`, the defined number range is used across all sales channels.", - "type": "boolean" - }, "name": { "type": "string" }, - "description": { - "type": "string" - }, - "pattern": { - "description": "Custom formatting in order to include for example, the date in the number range.", + "technicalName": { + "description": "Technical name of mail template.", "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" + "availableEntities": { + "type": "object" }, "customFields": { "type": "object" }, + "templateData": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -66196,23 +67385,17 @@ "translated": { "type": "object" }, - "type": { - "$ref": "#/components/schemas/NumberRangeType" - }, - "numberRangeSalesChannels": { + "mailTemplates": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/MailTemplate" } - }, - "state": { - "$ref": "#/components/schemas/NumberRangeState" } }, "type": "object" }, - "NumberRangeSalesChannelJsonApi": { - "description": "Added since version: 6.0.0.0", + "MainCategoryJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -66220,7 +67403,8 @@ { "required": [ "id", - "numberRangeId", + "productId", + "categoryId", "salesChannelId" ], "properties": { @@ -66228,18 +67412,26 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number rage.", + "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of Sales channels.", + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeTypeId": { - "description": "Unique identity of number rage type.", + "categoryId": { + "description": "Unique identity of the category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -66255,7 +67447,7 @@ }, "relationships": { "properties": { - "numberRange": { + "product": { "properties": { "links": { "type": "object", @@ -66263,7 +67455,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" } } }, @@ -66272,12 +67464,41 @@ "properties": { "type": { "type": "string", - "example": "number_range" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "category": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c4ef352f74e502ef5e7bc98e6f4e493d" } } } @@ -66292,7 +67513,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" } } }, @@ -66312,8 +67533,137 @@ } }, "type": "object" - }, - "numberRangeType": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MainCategory": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "productId", + "categoryId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "description": "Unique identity of the category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "measurementSystem": { "properties": { "links": { "type": "object", @@ -66321,7 +67671,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" } } }, @@ -66330,12 +67680,12 @@ "properties": { "type": { "type": "string", - "example": "number_range_type" + "example": "measurement_system" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "3d771a402fc5aa3349c2c15637058e8c" + "example": "c0484ac171c930ce54e78cd2e0d80e5a" } } } @@ -66350,32 +67700,48 @@ } ] }, - "NumberRangeSalesChannel": { - "description": "Added since version: 6.0.0.0", + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "numberRangeId", - "salesChannelId" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number rage.", + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of Sales channels.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "default": { + "type": "boolean" }, - "numberRangeTypeId": { - "description": "Unique identity of number rage type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -66387,20 +67753,17 @@ "format": "date-time", "readOnly": true }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "translated": { + "type": "object" }, - "numberRangeType": { - "$ref": "#/components/schemas/NumberRangeType" + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "NumberRangeStateJsonApi": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -66408,22 +67771,21 @@ { "required": [ "id", - "numberRangeId", - "lastValue" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number range.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, - "lastValue": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -66435,9 +67797,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "numberRange": { + "units": { "properties": { "links": { "type": "object", @@ -66445,21 +67810,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } } } } @@ -66474,26 +67841,25 @@ } ] }, - "NumberRangeState": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "numberRangeId", - "lastValue" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { - "description": "Unique identity of number range.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, - "lastValue": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -66505,13 +67871,19 @@ "format": "date-time", "readOnly": true }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" + "translated": { + "type": "object" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } } }, "type": "object" }, - "NumberRangeTypeJsonApi": { + "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -66519,29 +67891,85 @@ }, { "required": [ - "id", - "global", - "typeName" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Name of the number range type.", + "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" }, - "typeName": { + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, - "global": { - "description": "When set to `true`, the defined number range type is used across all sales channels.", + "uploadedAt": { + "description": "Date and time at which media was added.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fileName": { + "description": "Name of the media file uploaded.", + "type": "string" + }, + "fileSize": { + "description": "Size of the file media file uploaded.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaData": { + "type": "object", + "readOnly": true + }, + "mediaType": { + "type": "object", + "readOnly": true + }, + "config": { + "type": "object" + }, + "alt": { + "type": "string" + }, + "title": { + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -66555,9 +67983,292 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + }, + "themeMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } + } + } + } + }, + "type": "object" + }, + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3c88197809d464216a8c40a8db191b38" + } + } + } + }, + "type": "object" + }, + "ssoProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + }, + "quoteLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } + } + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "numberRanges": { + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "3b8779ba05b8f0aed49650f3ff8beb4b" + } + } + } + } + }, + "type": "object" + }, + "user": { "properties": { "links": { "type": "object", @@ -66565,7 +68276,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" + "example": "/media/3b563524fdb17b4a86590470d40bef74/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" } } }, @@ -66576,11 +68316,11 @@ "properties": { "type": { "type": "string", - "example": "number_range" + "example": "category" }, "id": { "type": "string", - "example": "d28d88efea70a67487116019cff39002" + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } @@ -66588,7 +68328,7 @@ }, "type": "object" }, - "numberRangeSalesChannels": { + "productManufacturers": { "properties": { "links": { "type": "object", @@ -66596,7 +68336,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" } } }, @@ -66607,400 +68347,143 @@ "properties": { "type": { "type": "string", - "example": "number_range_sales_channel" + "example": "product_manufacturer" }, "id": { "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" + "example": "30e3a0f8868364c06aa4be63426c1c79" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "NumberRangeType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "global", - "typeName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "description": "Name of the number range type.", - "type": "string" - }, - "typeName": { - "type": "string" - }, - "global": { - "description": "When set to `true`, the defined number range type is used across all sales channels.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "numberRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - }, - "numberRangeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - }, - "type": "object" - }, - "OrderJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderNumber": { - "description": "Unique number associated with every order.", - "type": "string" - }, - "billingAddressId": { - "description": "Unique identity of the billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderTransactionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderTransactionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "description": "Unique identity of the currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of the language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderDateTime": { - "description": "Timestamp when the order was placed.", - "type": "string", - "format": "date-time" - }, - "orderDate": { - "description": "Date when the order was placed.", - "type": "string", - "readOnly": true - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "amountTotal": { - "description": "Gross price of the order.", - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "description": "Net price of the order.", - "type": "number", - "format": "float", - "readOnly": true - }, - "positionPrice": { - "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", - "type": "number", - "format": "float", - "readOnly": true - }, - "taxStatus": { - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", - "type": "string", - "readOnly": true - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" }, - "referencePrice": { + "productMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "example": "2b5e079404830806ea36b6c17438cffd" + } + } + } + } + }, "type": "object" }, - "listPrice": { + "productDownloads": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_download" + }, + "id": { + "type": "string", + "example": "86db490c1f4f52d155dbdb978b1f45d3" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "orderLineItemDownloads": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item_download" + }, + "id": { + "type": "string", + "example": "8c0a5ecd281c97a912c27c0237b3848f" + } + } + } } }, "type": "object" - } - }, - "type": "object" - }, - "shippingTotal": { - "description": "Total shipping cost of the ordered product.", - "type": "number", - "format": "float", - "readOnly": true - }, - "currencyFactor": { - "description": "Rate at which currency is exchanged.", - "type": "number", - "format": "float" - }, - "deepLinkCode": { - "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", - "type": "string" - }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", - "type": "string" - }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "type": "string" - }, - "customerComment": { - "description": "Comments given by comments.", - "type": "string" - }, - "internalComment": { - "type": "string" - }, - "source": { - "description": "Source of orders either via normal order placement or subscriptions.", - "type": "string" - }, - "taxCalculationType": { - "type": "string" - }, - "stateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdById": { - "description": "Unique identity of createdBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "description": "Unique identity of updatedBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "subscription": { + "avatarUsers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "1fc09529f6c95370eb20b81318ff601f" + } + } + } + } + }, + "type": "object" + }, + "mediaFolder": { "properties": { "links": { "type": "object", @@ -67008,7 +68491,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" } } }, @@ -67017,19 +68500,19 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + "example": "70605921a592ee735964394f7948773b" } } } }, "type": "object" }, - "initialSubscriptions": { + "propertyGroupOptions": { "properties": { "links": { "type": "object", @@ -67037,7 +68520,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" } } }, @@ -67048,11 +68531,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "property_group_option" }, "id": { "type": "string", - "example": "3b40c275cdd1f84402bcef5be1651f64" + "example": "789104e3568fde835b6239b251d4aa07" } } } @@ -67060,7 +68543,7 @@ }, "type": "object" }, - "delayActions": { + "mailTemplateMedia": { "properties": { "links": { "type": "object", @@ -67068,7 +68551,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" } } }, @@ -67079,11 +68562,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "mail_template_media" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "9970132c8439a2e630b655812b031459" } } } @@ -67091,7 +68574,7 @@ }, "type": "object" }, - "warehouseGroups": { + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -67099,7 +68582,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" } } }, @@ -67110,11 +68593,11 @@ "properties": { "type": { "type": "string", - "example": "order_warehouse_group" + "example": "document_base_config" }, "id": { "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } @@ -67122,7 +68605,7 @@ }, "type": "object" }, - "warehouseProducts": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -67130,7 +68613,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" + "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" } } }, @@ -67141,11 +68624,11 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "shipping_method" }, "id": { "type": "string", - "example": "702258c6879958a41dfc328ad5c00325" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -67153,7 +68636,7 @@ }, "type": "object" }, - "returns": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -67161,7 +68644,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" } } }, @@ -67172,11 +68655,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "payment_method" }, "id": { "type": "string", - "example": "7fff84525c6516919851a9005373f87e" + "example": "b631b1ab565525e892f9cdc1242cca14" } } } @@ -67184,7 +68667,7 @@ }, "type": "object" }, - "orderEmployee": { + "productConfiguratorSettings": { "properties": { "links": { "type": "object", @@ -67192,7 +68675,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" } } }, @@ -67203,11 +68686,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_order_employee" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "5ea451c08a87db806089c4031601c29a" + "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" } } } @@ -67215,7 +68698,7 @@ }, "type": "object" }, - "quote": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -67223,28 +68706,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } } } } }, "type": "object" }, - "b2bPendingOrder": { + "cmsSections": { "properties": { "links": { "type": "object", @@ -67252,7 +68768,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" } } }, @@ -67263,11 +68779,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "cms_section" }, "id": { "type": "string", - "example": "c7e0572188e2dec59215e8872024567e" + "example": "53be3cc1c4a8f41af67a90cf9fd09194" } } } @@ -67275,7 +68791,7 @@ }, "type": "object" }, - "organization": { + "cmsPages": { "properties": { "links": { "type": "object", @@ -67283,28 +68799,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "example": "e676148cc6ffb82b89b3903ecaed2d16" + } + } + } + } + }, + "type": "object" + }, + "documents": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } } } } }, "type": "object" }, - "budget": { + "a11yDocuments": { "properties": { "links": { "type": "object", @@ -67312,213 +68861,606 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + "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": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "b2b_components_budget" - }, - "id": { + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "e53c737d351047e64a02b7a2a4caffe3" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } } } } - }, - "type": "object" + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Media": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "description": "Unique identity of the user", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderId": { + "description": "Unique identity of the media folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" + }, + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" + }, + "uploadedAt": { + "description": "Date and time at which media was added.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fileName": { + "description": "Name of the media file uploaded.", + "type": "string" + }, + "fileSize": { + "description": "Size of the file media file uploaded.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaData": { + "type": "object", + "readOnly": true + }, + "mediaType": { + "type": "object", + "readOnly": true + }, + "config": { + "type": "object" + }, + "alt": { + "type": "string" + }, + "title": { + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "private": { + "description": "When `true`, the media display is kept private.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "fileHash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + }, + "themeMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } + } + } + } + }, + "type": "object" + }, + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3c88197809d464216a8c40a8db191b38" + } + } + } + }, + "type": "object" + }, + "ssoProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } } }, "type": "object" }, - "relationships": { + "quoteLineItems": { "properties": { - "stateMachineState": { - "description": "Current order state (e.g., open, in_progress, completed, cancelled)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" - } - } - } - }, - "type": "object" - }, - "primaryOrderDelivery": { - "description": "Primary delivery information for the order", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "fdeeebdae32b4dfa39d3f4372d0554e9" - } - } - } - }, - "type": "object" - }, - "primaryOrderTransaction": { - "description": "Primary payment transaction for the order", + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "bbaa9e50388c524d97853a4fc4476b0e" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" } - }, - "type": "object" + } }, - "orderCustomer": { - "description": "Customer information associated with the order", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e90c9c228c1510f5a25902f7a1e8426a" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" } } - }, - "type": "object" - }, - "currency": { - "description": "Currency used for the order", + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" } - }, - "type": "object" + } }, - "language": { - "description": "Language used when placing the order", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" } } - }, - "type": "object" - }, - "salesChannel": { + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "productManufacturers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + }, + "productMedia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + }, + "productDownloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + }, + "orderLineItemDownloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + }, + "avatarUsers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + }, + "mediaFolder": { + "$ref": "#/components/schemas/MediaFolder" + }, + "propertyGroupOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "mailTemplateMedia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } + }, + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "productConfiguratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "cmsSections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "cmsPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "appPaymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + }, + "type": "object" + }, + "MediaAiTagJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int64" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "media": { "properties": { "links": { "type": "object", @@ -67526,7 +69468,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" + "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" } } }, @@ -67535,52 +69477,110 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "addresses": { - "description": "All addresses associated with the order (billing and shipping)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_address" - }, - "id": { - "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" - } + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" - }, - "billingAddress": { - "description": "Billing address for the order", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaAiTag": { + "required": [ + "id", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int64" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MediaDefaultFolderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "folder": { "properties": { "links": { "type": "object", @@ -67588,7 +69588,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" + "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, @@ -67597,20 +69597,126 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7fee8ff88b768662dd8fc06e1b6997d2" + "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } }, "type": "object" - }, - "deliveries": { - "description": "Delivery information including shipping address and tracking", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaDefaultFolder": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "entity" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "folder": { + "$ref": "#/components/schemas/MediaFolder" + } + }, + "type": "object" + }, + "MediaFolderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configurationId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", + "type": "boolean" + }, + "configurationId": { + "description": "Unique identity of configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultFolderId": { + "description": "Unique identity of default folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the media folder.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of media folder.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -67618,95 +69724,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery" - }, - "id": { - "type": "string", - "example": "6fc31b6b9cd717cc0dcb81152308f8af" - } - } - } - } - }, - "type": "object" - }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" - } - } - } - } - }, - "type": "object" - }, - "transactions": { - "description": "Payment transactions for the order", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "media_folder" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction" - }, - "id": { - "type": "string", - "example": "c15b977dd99332ca8623fbdfb86827e8" - } + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", + "children": { "properties": { "links": { "type": "object", @@ -67714,7 +69753,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" } } }, @@ -67725,11 +69764,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "media_folder" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "268184c12df027f536154d099d497b31" } } } @@ -67737,8 +69776,7 @@ }, "type": "object" }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", + "media": { "properties": { "links": { "type": "object", @@ -67746,7 +69784,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" } } }, @@ -67757,11 +69795,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "media" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -67769,7 +69807,7 @@ }, "type": "object" }, - "createdBy": { + "defaultFolder": { "properties": { "links": { "type": "object", @@ -67777,7 +69815,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" } } }, @@ -67786,19 +69824,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "media_default_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "251dcc9b1621d34e6b01ee14c26b3027" } } } }, "type": "object" }, - "updatedBy": { + "configuration": { "properties": { "links": { "type": "object", @@ -67806,7 +69844,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" } } }, @@ -67815,12 +69853,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "media_folder_configuration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "ccd1066343c95877b75b79d47c36bebe" } } } @@ -67835,739 +69873,323 @@ } ] }, - "Order": { + "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding" + "configurationId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderNumber": { - "description": "Unique number associated with every order.", - "type": "string" - }, - "billingAddressId": { - "description": "Unique identity of the billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderTransactionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderTransactionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", + "type": "boolean" }, - "currencyId": { - "description": "Unique identity of the currency.", + "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of the language.", + "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDateTime": { - "description": "Timestamp when the order was placed.", - "type": "string", - "format": "date-time" - }, - "orderDate": { - "description": "Date when the order was placed.", - "type": "string", - "readOnly": true - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "amountTotal": { - "description": "Gross price of the order.", - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "description": "Net price of the order.", - "type": "number", - "format": "float", - "readOnly": true - }, - "positionPrice": { - "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", - "type": "number", - "format": "float", + "childCount": { + "type": "integer", + "format": "int64", "readOnly": true }, - "taxStatus": { - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "shippingTotal": { - "description": "Total shipping cost of the ordered product.", - "type": "number", - "format": "float", - "readOnly": true - }, - "currencyFactor": { - "description": "Rate at which currency is exchanged.", - "type": "number", - "format": "float" - }, - "deepLinkCode": { - "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", - "type": "string" - }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", - "type": "string" - }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "type": "string" - }, - "customerComment": { - "description": "Comments given by comments.", - "type": "string" - }, - "internalComment": { + "name": { + "description": "Name of media folder.", "type": "string" }, - "source": { - "description": "Source of orders either via normal order placement or subscriptions.", - "type": "string" + "customFields": { + "type": "object" }, - "taxCalculationType": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "stateId": { - "description": "Unique identity of state.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "ruleIds": { + "parent": { + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." + }, + "children": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/MediaFolder" } }, - "customFields": { - "type": "object" + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } }, - "createdById": { - "description": "Unique identity of createdBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "defaultFolder": { + "$ref": "#/components/schemas/MediaDefaultFolder" }, - "updatedById": { - "description": "Unique identity of updatedBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "configuration": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + }, + "type": "object" + }, + "MediaFolderConfigurationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "itemRounding": { + { "required": [ - "decimals", - "interval", - "roundForNet" + "id" ], "properties": { - "decimals": { - "type": "integer", - "format": "int64" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "interval": { - "type": "number", - "format": "float" + "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", + "type": "boolean" }, - "roundForNet": { + "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { + }, + "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { + "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "subscription": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" - } - } - } - }, - "type": "object" - }, - "initialSubscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "3b40c275cdd1f84402bcef5be1651f64" - } - } - } - } - }, - "type": "object" }, - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" + "noAssociation": { + "type": "boolean" }, - "warehouseGroups": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" - } - } - } - } - }, + "customFields": { "type": "object" }, - "warehouseProducts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_product_warehouse" - }, - "id": { - "type": "string", - "example": "702258c6879958a41dfc328ad5c00325" - } - } - } - } - }, - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "returns": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } - } - } - } - }, - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "orderEmployee": { + "relationships": { "properties": { - "links": { - "type": "object", + "mediaFolders": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_order_employee" - }, - "id": { - "type": "string", - "example": "5ea451c08a87db806089c4031601c29a" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" + } } - } - } - } - }, - "type": "object" - }, - "quote": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" - } - } - } - }, - "type": "object" - }, - "b2bPendingOrder": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "c7e0572188e2dec59215e8872024567e" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "example": "6e8238687513bde2e85821c839c597c6" + } + } } } - } - } - }, - "type": "object" - }, - "organization": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" - } - } - } - }, - "type": "object" - }, - "budget": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" - } - } + }, + "type": "object" }, - "data": { - "type": "object", + "mediaThumbnailSizes": { "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + } + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "example": "44dee48a0006e8db2fcec2a5e1456449" + } + } + } } - } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "MediaFolderConfiguration": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current order state (e.g., open, in_progress, completed, cancelled)" - }, - "primaryOrderDelivery": { - "$ref": "#/components/schemas/OrderDelivery", - "description": "Primary delivery information for the order" - }, - "primaryOrderTransaction": { - "$ref": "#/components/schemas/OrderTransaction", - "description": "Primary payment transaction for the order" + "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", + "type": "boolean" }, - "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer", - "description": "Customer information associated with the order" + "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", + "type": "boolean" }, - "currency": { - "$ref": "#/components/schemas/Currency", - "description": "Currency used for the order" + "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", + "type": "integer", + "format": "int64" }, - "language": { - "$ref": "#/components/schemas/Language", - "description": "Language used when placing the order" + "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", + "type": "boolean" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "noAssociation": { + "type": "boolean" }, - "addresses": { - "description": "All addresses associated with the order (billing and shipping)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } + "customFields": { + "type": "object" }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Billing address for the order" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "deliveries": { - "description": "Delivery information including shipping address and tracking", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", + "mediaFolders": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/MediaFolder" } }, - "transactions": { - "description": "Payment transactions for the order", + "mediaThumbnailSizes": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/MediaThumbnailSize" } + } + }, + "type": "object" + }, + "MediaFolderConfigurationMediaThumbnailSize": { + "description": "Added since version: 6.0.0.0", + "required": [ + "mediaFolderConfigurationId", + "mediaThumbnailSizeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "mediaFolderConfigurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "mediaFolderConfiguration": { + "$ref": "#/components/schemas/MediaFolderConfiguration" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" }, - "OrderAddressJsonApi": { + "MediaTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "mediaId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "MediaThumbnailJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -68576,102 +70198,46 @@ { "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "mediaId", + "width", + "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { - "description": "Unique identity of salutation.", + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "street": { - "description": "Street address", - "type": "string" - }, - "zipcode": { - "description": "Zip code of the country.", - "type": "string" - }, - "city": { - "description": "Name of the city.", - "type": "string" - }, - "company": { - "description": "Name of the company.", - "type": "string" - }, - "department": { - "description": "Name of the department.", - "type": "string" - }, - "title": { - "description": "Title name given to customer like DR. , Prof., etc.", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number of the customer.", - "type": "string" + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", - "type": "string" + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", + "url": { + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "path": { "type": "string" }, "customFields": { "type": "object" }, - "vatId": { - "description": "Unique identity of VAT.", - "type": "string", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -68684,36 +70250,7 @@ }, "relationships": { "properties": { - "country": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" - } - } - } - }, - "type": "object" - }, - "countryState": { + "media": { "properties": { "links": { "type": "object", @@ -68721,7 +70258,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" } } }, @@ -68730,19 +70267,19 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "order": { + "mediaThumbnailSize": { "properties": { "links": { "type": "object", @@ -68750,7 +70287,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" } } }, @@ -68759,19 +70296,132 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "media_thumbnail_size" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "0d0b8659a3a47e9d7e1481961f127fd0" } } } }, "type": "object" - }, - "orderDeliveries": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaThumbnail": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mediaId", + "width", + "height" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + }, + "type": "object" + }, + "MediaThumbnailSizeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "width", + "height" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "mediaFolderConfigurations": { "properties": { "links": { "type": "object", @@ -68779,7 +70429,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" } } }, @@ -68790,11 +70440,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "media_folder_configuration" }, "id": { "type": "string", - "example": "0ba472de56dd7ba2e7bb878434321e26" + "example": "056df7a700173d83ebb685b1a890f09b" } } } @@ -68802,7 +70452,7 @@ }, "type": "object" }, - "salutation": { + "mediaThumbnails": { "properties": { "links": { "type": "object", @@ -68810,21 +70460,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } } } } @@ -68839,138 +70491,57 @@ } ] }, - "OrderAddress": { + "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "width", + "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "street": { - "description": "Street address", - "type": "string" - }, - "zipcode": { - "description": "Zip code of the country.", - "type": "string" - }, - "city": { - "description": "Name of the city.", - "type": "string" - }, - "company": { - "description": "Name of the company.", - "type": "string" - }, - "department": { - "description": "Name of the department.", - "type": "string" - }, - "title": { - "description": "Title name given to customer like DR. , Prof., etc.", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number of the customer.", - "type": "string" - }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", - "type": "string" - }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", - "type": "string" + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" }, - "vatId": { - "description": "Unique identity of VAT.", - "type": "string", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "order": { - "$ref": "#/components/schemas/Order" + "type": "string", + "format": "date-time", + "readOnly": true }, - "orderDeliveries": { + "mediaFolderConfigurations": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/MediaFolderConfiguration" } }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } }, "type": "object" }, - "OrderCustomerJsonApi": { + "NewsletterRecipientJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -68979,75 +70550,81 @@ { "required": [ "id", - "orderId", "email", - "firstName", - "lastName" + "status", + "hash", + "languageId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "email": { - "description": "Email address of the customer.", + "description": "Email of the recipient.", "type": "string" }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": { + "description": "Title of the recipient's newsletter.", + "type": "string" }, "firstName": { - "description": "First name of the customer.", + "description": "First name of the recipient.", "type": "string" }, "lastName": { - "description": "Last name of the customer.", + "description": "Last name of the recipient.", "type": "string" }, - "company": { - "description": "Name of the company.", + "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "city": { + "description": "City of the recipient.", "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } + "street": { + "description": "Street of the recipient.", + "type": "string" }, - "customerNumber": { - "description": "Unique number assigned to the customer.", + "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] + }, + "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" + "confirmedAt": { + "description": "Date and time when the Newsletter was received.", + "type": "string", + "format": "date-time" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -69061,7 +70638,7 @@ }, "relationships": { "properties": { - "order": { + "tags": { "properties": { "links": { "type": "object", @@ -69069,7 +70646,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" } } }, @@ -69078,19 +70686,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "customer": { + "language": { "properties": { "links": { "type": "object", @@ -69098,7 +70706,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, @@ -69107,19 +70715,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "salutation": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -69127,7 +70735,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, @@ -69136,12 +70744,12 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -69156,79 +70764,85 @@ } ] }, - "OrderCustomer": { + "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", "email", - "firstName", - "lastName" + "status", + "hash", + "languageId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "email": { - "description": "Email address of the customer.", + "description": "Email of the recipient.", "type": "string" }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": { + "description": "Title of the recipient's newsletter.", + "type": "string" }, "firstName": { - "description": "First name of the customer.", + "description": "First name of the recipient.", "type": "string" }, "lastName": { - "description": "Last name of the customer.", + "description": "Last name of the recipient.", "type": "string" }, - "company": { - "description": "Name of the company.", + "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "city": { + "description": "City of the recipient.", "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } + "street": { + "description": "Street of the recipient.", + "type": "string" }, - "customerNumber": { - "description": "Unique number assigned to the customer.", + "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] + }, + "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" + "confirmedAt": { + "description": "Date and time when the Newsletter was received.", + "type": "string", + "format": "date-time" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -69240,20 +70854,54 @@ "format": "date-time", "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "customer": { - "$ref": "#/components/schemas/Customer" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, "salutation": { "$ref": "#/components/schemas/Salutation" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "OrderDeliveryJsonApi": { + "NewsletterRecipientTag": { "description": "Added since version: 6.0.0.0", + "required": [ + "newsletterRecipientId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "newsletterRecipientId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "newsletterRecipient": { + "$ref": "#/components/schemas/NewsletterRecipient" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "NotificationJsonApi": { + "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -69261,122 +70909,224 @@ { "required": [ "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" + "status", + "message" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" }, - "shippingOrderAddressVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of state.", + "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "trackingCodes": { - "type": "array", - "items": { - "type": "string" - } - }, - "shippingDateEarliest": { - "description": "Date and time of earliest delivery of products.", + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products.", + "updatedAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], + "relationships": { "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { + "createdByIntegration": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "4698501400b26be8a41def09646e1b59" + } + } } }, "type": "object" }, - "regulationPrice": { + "createdByUser": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8a66af2fd5b68899934d19e078c9c111" + } + } } }, "type": "object" } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "Notification": { + "description": "Added since version: 6.4.7.0", + "required": [ + "id", + "status", + "message" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" + }, + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" + }, + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" + }, + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdByUserId": { + "description": "Unique identity of createdByUser.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "createdByIntegration": { + "$ref": "#/components/schemas/Integration" + }, + "createdByUser": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "NumberRangeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "typeId", + "global", + "pattern", + "start", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "description": "Unique identity of type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", + "type": "string" + }, + "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -69391,10 +71141,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "stateMachineState": { - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", + "type": { "properties": { "links": { "type": "object", @@ -69402,7 +71154,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, @@ -69411,19 +71163,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "order": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -69431,29 +71183,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } } } } }, "type": "object" }, - "shippingOrderAddress": { - "description": "Shipping address for this delivery", + "state": { "properties": { "links": { "type": "object", @@ -69461,7 +71214,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" } } }, @@ -69470,20 +71223,141 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "39a8592767b8b6a5d6b1dbc47e4058ca" + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" - }, - "shippingMethod": { - "description": "Shipping method used for this delivery", + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRange": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "typeId", + "global", + "pattern", + "start", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "description": "Unique identity of type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", + "type": "string" + }, + "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "type": { + "$ref": "#/components/schemas/NumberRangeType" + }, + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + }, + "state": { + "$ref": "#/components/schemas/NumberRangeState" + } + }, + "type": "object" + }, + "NumberRangeSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "numberRangeId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "description": "Unique identity of number rage.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of Sales channels.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeTypeId": { + "description": "Unique identity of number rage type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "numberRange": { "properties": { "links": { "type": "object", @@ -69491,7 +71365,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, @@ -69500,20 +71374,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, - "positions": { - "description": "Line items included in this delivery", + "salesChannel": { "properties": { "links": { "type": "object", @@ -69521,30 +71394,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery_position" - }, - "id": { - "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "primaryOrder": { + "numberRangeType": { "properties": { "links": { "type": "object", @@ -69552,7 +71423,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, @@ -69561,12 +71432,12 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f3654baea1bb37cbbd3b86e9793c3766" + "example": "3d771a402fc5aa3349c2c15637058e8c" } } } @@ -69581,130 +71452,33 @@ } ] }, - "OrderDelivery": { + "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" + "numberRangeId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingOrderAddressVersionId": { + "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of state.", + "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "trackingCodes": { - "type": "array", - "items": { - "type": "string" - } - }, - "shippingDateEarliest": { - "description": "Date and time of earliest delivery of products.", - "type": "string", - "format": "date-time" - }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products.", - "type": "string", - "format": "date-time" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -69715,148 +71489,44 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Shipping address for this delivery" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "description": "Shipping method used for this delivery" + "numberRange": { + "$ref": "#/components/schemas/NumberRange" }, - "positions": { - "description": "Line items included in this delivery", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "primaryOrder": { - "$ref": "#/components/schemas/Order" + "numberRangeType": { + "$ref": "#/components/schemas/NumberRangeType" } }, "type": "object" - }, - "OrderDeliveryPositionJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "orderDeliveryId", - "orderLineItemId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderDeliveryId": { - "description": "Unique identity of order delivery.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { - "description": "Unique identity of line items in an order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "unitPrice": { - "description": "Price of product per item (where, quantity=1).", - "type": "number", - "format": "float" + }, + "NumberRangeStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "numberRangeId", + "lastValue" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "description": "Cost of product based on quantity.", - "type": "number", - "format": "float" + "numberRangeId": { + "description": "Unique identity of number range.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "description": "Number of items of each product.", + "lastValue": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -69869,36 +71539,7 @@ }, "relationships": { "properties": { - "orderDelivery": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_delivery" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "473c50bdac32ac0dc66364d121260dce" - } - } - } - }, - "type": "object" - }, - "orderLineItem": { + "numberRange": { "properties": { "links": { "type": "object", @@ -69906,7 +71547,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" + "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" } } }, @@ -69915,12 +71556,12 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } @@ -69935,111 +71576,181 @@ } ] }, - "OrderDeliveryPosition": { + "NumberRangeState": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderDeliveryId", - "orderLineItemId" + "numberRangeId", + "lastValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryId": { - "description": "Unique identity of order delivery.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "lastValue": { + "type": "integer", + "format": "int64" }, - "orderDeliveryVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderLineItemId": { - "description": "Unique identity of line items in an order.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "numberRange": { + "$ref": "#/components/schemas/NumberRange" + } + }, + "type": "object" + }, + "NumberRangeTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "price": { + { "required": [ - "unitPrice", - "totalPrice", - "quantity" + "id", + "global", + "typeName" ], "properties": { - "unitPrice": { - "type": "number", - "format": "float" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "type": "number", - "format": "float" + "technicalName": { + "description": "Name of the number range type.", + "type": "string" }, - "quantity": { - "type": "integer", - "format": "int64" + "typeName": { + "type": "string" }, - "calculatedTaxes": { - "type": "object" + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, - "taxRules": { + "customFields": { "type": "object" }, - "referencePrice": { - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" }, - "regulationPrice": { + "relationships": { "properties": { - "price": { - "type": "number", - "format": "float" + "numberRanges": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range" + }, + "id": { + "type": "string", + "example": "d28d88efea70a67487116019cff39002" + } + } + } + } + }, + "type": "object" + }, + "numberRangeSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } + } + } + } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "NumberRangeType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "global", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unitPrice": { - "description": "Price of product per item (where, quantity=1).", - "type": "number", - "format": "float" + "technicalName": { + "description": "Name of the number range type.", + "type": "string" }, - "totalPrice": { - "description": "Cost of product based on quantity.", - "type": "number", - "format": "float" + "typeName": { + "type": "string" }, - "quantity": { - "description": "Number of items of each product.", - "type": "integer", - "format": "int64" + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, "customFields": { "type": "object" @@ -70054,16 +71765,25 @@ "format": "date-time", "readOnly": true }, - "orderDelivery": { - "$ref": "#/components/schemas/OrderDelivery" + "translated": { + "type": "object" }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" + "numberRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + }, + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } } }, "type": "object" }, - "OrderLineItemJsonApi": { + "OrderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -70072,13 +71792,15 @@ { "required": [ "id", - "orderId", - "identifier", - "quantity", - "label", - "price", - "children", - "states" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding" ], "properties": { "id": { @@ -70089,80 +71811,126 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "description": "Unique identity of order.", + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "description": "Unique number associated with every order.", + "type": "string" + }, + "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of product.", + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { - "description": "Unique identity of product.", + "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentVersionId": { + "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverId": { - "description": "Unique identity of cover image.", + "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "description": "It is a unique identity of an item in cart before its converted to an order.", - "type": "string" - }, - "referencedId": { - "description": "Unique identity of type of entity.", - "type": "string" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "description": "Number of items of product.", - "type": "integer", - "format": "int64" + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" }, - "label": { - "description": "It is a typical product name given to the line item.", - "type": "string" + "orderDate": { + "description": "Date when the order was placed.", + "type": "string", + "readOnly": true }, - "payload": { + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, "type": "object" }, - "good": { - "description": "When set to true, it indicates the line item is physical else it is virtual.", - "type": "boolean" + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "removable": { - "description": "Allows the line item to be removable from the cart when set to true.", - "type": "boolean" + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "stackable": { - "description": "Allows to change the quantity of the line item when set to true.", - "type": "boolean" + "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", + "type": "number", + "format": "float", + "readOnly": true }, - "position": { - "description": "Position of line items placed in an order.", - "type": "integer", - "format": "int64" + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true }, - "price": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -70219,45 +71987,108 @@ }, "type": "object" }, - "priceDefinition": { - "type": "object" - }, - "unitPrice": { - "description": "Price of product per item (where, quantity=1).", + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", - "format": "float" + "format": "float", + "readOnly": true }, - "totalPrice": { - "description": "Cost of product based on quantity.", + "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, - "description": { - "description": "Description of line items in an order.", + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, - "type": { - "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "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", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "container", - "discount", - "quantity" - ] + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" }, - "states": { - "type": "array", - "items": { - "type": "string" + "createdById": { + "description": "Unique identity of createdBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } }, - "deprecated": true + "type": "object" }, "createdAt": { "type": "string", @@ -70271,73 +72102,7 @@ }, "extensions": { "properties": { - "returns": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } - } - } - } - }, - "type": "object" - }, - "state": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "cover": { - "description": "Line item image or thumbnail", + "subscription": { "properties": { "links": { "type": "object", @@ -70345,7 +72110,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" } } }, @@ -70354,19 +72119,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, - "order": { + "initialSubscriptions": { "properties": { "links": { "type": "object", @@ -70374,29 +72139,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } } } } }, "type": "object" }, - "product": { - "description": "Referenced product if this is a product line item", + "delayActions": { "properties": { "links": { "type": "object", @@ -70404,28 +72170,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } } } } }, "type": "object" }, - "promotion": { + "warehouseGroups": { "properties": { "links": { "type": "object", @@ -70433,29 +72201,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } } } } }, "type": "object" }, - "orderDeliveryPositions": { - "description": "Delivery positions for this line item", + "warehouseProducts": { "properties": { "links": { "type": "object", @@ -70463,7 +72232,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" } } }, @@ -70474,11 +72243,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "order_product_warehouse" }, "id": { "type": "string", - "example": "76d4619a36f864b08f57415baaa685ec" + "example": "702258c6879958a41dfc328ad5c00325" } } } @@ -70486,7 +72255,7 @@ }, "type": "object" }, - "orderTransactionCaptureRefundPositions": { + "returns": { "properties": { "links": { "type": "object", @@ -70494,7 +72263,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" } } }, @@ -70505,11 +72274,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund_position" + "example": "order_return" }, "id": { "type": "string", - "example": "c330b64e5adc1e48e07a78aa79e5b27a" + "example": "7fff84525c6516919851a9005373f87e" } } } @@ -70517,8 +72286,7 @@ }, "type": "object" }, - "downloads": { - "description": "Digital downloads associated with this line item", + "orderEmployee": { "properties": { "links": { "type": "object", @@ -70526,7 +72294,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" } } }, @@ -70537,11 +72305,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "b2b_order_employee" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "5ea451c08a87db806089c4031601c29a" } } } @@ -70549,7 +72317,7 @@ }, "type": "object" }, - "parent": { + "quote": { "properties": { "links": { "type": "object", @@ -70557,7 +72325,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" } } }, @@ -70566,431 +72334,50 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "children": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderLineItem": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderId", - "identifier", - "quantity", - "label", - "price", - "children", - "states" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "description": "Unique identity of product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "promotionId": { - "description": "Unique identity of product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "coverId": { - "description": "Unique identity of cover image.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "description": "It is a unique identity of an item in cart before its converted to an order.", - "type": "string" - }, - "referencedId": { - "description": "Unique identity of type of entity.", - "type": "string" - }, - "quantity": { - "description": "Number of items of product.", - "type": "integer", - "format": "int64" - }, - "label": { - "description": "It is a typical product name given to the line item.", - "type": "string" - }, - "payload": { - "type": "object" - }, - "good": { - "description": "When set to true, it indicates the line item is physical else it is virtual.", - "type": "boolean" - }, - "removable": { - "description": "Allows the line item to be removable from the cart when set to true.", - "type": "boolean" - }, - "stackable": { - "description": "Allows to change the quantity of the line item when set to true.", - "type": "boolean" - }, - "position": { - "description": "Position of line items placed in an order.", - "type": "integer", - "format": "int64" - }, - "price": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "priceDefinition": { - "type": "object" - }, - "unitPrice": { - "description": "Price of product per item (where, quantity=1).", - "type": "number", - "format": "float" - }, - "totalPrice": { - "description": "Cost of product based on quantity.", - "type": "number", - "format": "float" - }, - "description": { - "description": "Description of line items in an order.", - "type": "string" - }, - "type": { - "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "container", - "discount", - "quantity" - ] - }, - "customFields": { - "type": "object" - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "deprecated": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "returns": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } - } - } - } - }, - "type": "object" - }, - "state": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } } - } + }, + "type": "object" }, - "data": { - "type": "object", + "b2bPendingOrder": { "properties": { - "type": { - "type": "string", - "example": "state_machine_state" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + } + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c7e0572188e2dec59215e8872024567e" + } + } + } } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "cover": { - "$ref": "#/components/schemas/Media", - "description": "Line item image or thumbnail" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "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" - } - }, - "orderTransactionCaptureRefundPositions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - }, - "downloads": { - "description": "Digital downloads associated with this line item", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - }, - "parent": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - }, - "type": "object" - }, - "OrderLineItemDownloadJsonApi": { - "description": "Added since version: 6.4.19.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "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": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "orderLineItem": { + }, + "type": "object" + }, + "organization": { "properties": { "links": { "type": "object", @@ -70998,7 +72385,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" } } }, @@ -71007,19 +72394,19 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, - "media": { + "budget": { "properties": { "links": { "type": "object", @@ -71027,7 +72414,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" } } }, @@ -71036,12 +72423,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "2f212049ce79d2b949fd242043004288" } } } @@ -71050,133 +72437,11 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderLineItemDownload": { - "description": "Added since version: 6.4.19.0", - "required": [ - "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "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": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "OrderProductWarehouseJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "orderId", - "productId", - "warehouseId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "warehouseId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, "relationships": { "properties": { - "order": { + "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -71184,7 +72449,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" } } }, @@ -71193,19 +72458,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "product": { + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", @@ -71213,7 +72479,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" } } }, @@ -71222,19 +72488,20 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" } } } }, "type": "object" }, - "warehouse": { + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", "properties": { "links": { "type": "object", @@ -71242,7 +72509,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" } } }, @@ -71251,255 +72518,20 @@ "properties": { "type": { "type": "string", - "example": "warehouse" + "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "372d30dd2849813ef674855253900679" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderProductWarehouse": { - "required": [ - "id", - "orderId", - "productId", - "warehouseId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "warehouseId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "warehouse": { - "$ref": "#/components/schemas/Warehouse" - } - }, - "type": "object" - }, - "OrderReturnJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "orderId", - "stateId", - "returnNumber", - "requestedAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } } }, "type": "object" }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "returnNumber": { - "type": "string" - }, - "requestedAt": { - "type": "string", - "format": "date-time" - }, - "amountTotal": { - "type": "number", - "format": "float" - }, - "amountNet": { - "type": "number", - "format": "float" - }, - "internalComment": { - "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "order": { + "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -71507,7 +72539,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" } } }, @@ -71516,19 +72548,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "e90c9c228c1510f5a25902f7a1e8426a" } } } }, "type": "object" }, - "state": { + "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -71536,7 +72569,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" } } }, @@ -71545,19 +72578,20 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "createdBy": { + "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -71565,7 +72599,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/createdBy" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" } } }, @@ -71574,19 +72608,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "updatedBy": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -71594,7 +72628,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" } } }, @@ -71603,19 +72637,20 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "lineItems": { + "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -71623,7 +72658,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" } } }, @@ -71634,342 +72669,146 @@ "properties": { "type": { "type": "string", - "example": "order_return_line_item" + "example": "order_address" }, "id": { "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" + "example": "963e3a2fe559e393bad631f3dc686f69" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderReturn": { - "required": [ - "id", - "orderId", - "stateId", - "returnNumber", - "requestedAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "returnNumber": { - "type": "string" - }, - "requestedAt": { - "type": "string", - "format": "date-time" - }, - "amountTotal": { - "type": "number", - "format": "float" - }, - "amountNet": { - "type": "number", - "format": "float" - }, - "internalComment": { - "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - }, - "type": "object" - }, - "OrderReturnLineItemJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderReturnId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderReturnVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "reasonId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "price": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" }, - "referencePrice": { + "billingAddress": { + "description": "Billing address for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7fee8ff88b768662dd8fc06e1b6997d2" + } + } + } + }, "type": "object" }, - "listPrice": { + "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "example": "6fc31b6b9cd717cc0dcb81152308f8af" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } + } + } } }, "type": "object" - } - }, - "type": "object" - }, - "refundAmount": { - "type": "number", - "format": "float" - }, - "restockQuantity": { - "type": "integer", - "format": "int64" - }, - "internalComment": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "reason": { + }, + "transactions": { + "description": "Payment transactions for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "c15b977dd99332ca8623fbdfb86827e8" + } + } + } + } + }, + "type": "object" + }, + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -71977,28 +72816,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item_reason" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "40bea8d637cdf2c1b07fcf0630482b73" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } } } } }, "type": "object" }, - "state": { + "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -72006,28 +72848,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "return": { + "createdBy": { "properties": { "links": { "type": "object", @@ -72035,7 +72879,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" } } }, @@ -72044,19 +72888,19 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "lineItem": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -72064,7 +72908,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" } } }, @@ -72073,12 +72917,12 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "867cf1ff92974922abc5d5b045b4a2d8" + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -72093,15 +72937,19 @@ } ] }, - "OrderReturnLineItem": { + "Order": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding" ], "properties": { "id": { @@ -72112,31 +72960,126 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "description": "Unique number associated with every order.", + "type": "string" + }, + "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnVersionId": { + "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { + "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "integer", - "format": "int64" + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of the currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" + }, + "orderDate": { + "description": "Date when the order was placed.", + "type": "string", + "readOnly": true }, "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", + "type": "number", + "format": "float", + "readOnly": true + }, + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true + }, + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -72158,230 +73101,575 @@ "calculatedTaxes": { "type": "object" }, - "taxRules": { + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", + "type": "number", + "format": "float", + "readOnly": true + }, + "currencyFactor": { + "description": "Rate at which currency is exchanged.", + "type": "number", + "format": "float" + }, + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { + "type": "string" + }, + "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdById": { + "description": "Unique identity of createdBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "subscription": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + } + } + } + }, + "type": "object" + }, + "initialSubscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" + }, + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, + "type": "object" + }, + "warehouseProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "702258c6879958a41dfc328ad5c00325" + } + } + } + } + }, + "type": "object" + }, + "returns": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, "type": "object" }, - "referencePrice": { + "orderEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_order_employee" + }, + "id": { + "type": "string", + "example": "5ea451c08a87db806089c4031601c29a" + } + } + } + } + }, "type": "object" }, - "listPrice": { + "quote": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } } }, "type": "object" }, - "regulationPrice": { + "b2bPendingOrder": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c7e0572188e2dec59215e8872024567e" + } + } + } } }, "type": "object" - } - }, - "type": "object" - }, - "refundAmount": { - "type": "number", - "format": "float" - }, - "restockQuantity": { - "type": "integer", - "format": "int64" - }, - "internalComment": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "reason": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "return": { - "$ref": "#/components/schemas/OrderReturn" - }, - "lineItem": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "type": "object" - }, - "OrderReturnLineItemReasonJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "reasonKey" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "reasonKey": { - "type": "string" - }, - "content": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, - "translated": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, "type": "object" }, - "relationships": { + "budget": { "properties": { - "lineItems": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" - } - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "OrderReturnLineItemReason": { - "required": [ - "id", - "reasonKey" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "reasonKey": { - "type": "string" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, - "content": { - "type": "string" + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "orderCustomer": { + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, - "translated": { - "type": "object" + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "addresses": { + "description": "All addresses associated with the order (billing and shipping)", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "billingAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" + }, + "deliveries": { + "description": "Delivery information including shipping address and tracking", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderLineItem" } - } - }, - "type": "object" - }, - "OrderTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "orderId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "transactions": { + "description": "Payment transactions for the order", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "tags": { + "description": "Tags assigned to the order for organization and filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "order": { - "$ref": "#/components/schemas/Order" + "createdBy": { + "$ref": "#/components/schemas/User" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "updatedBy": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "OrderTransactionJsonApi": { + "OrderAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -72390,10 +73678,12 @@ { "required": [ "id", + "countryId", "orderId", - "paymentMethodId", - "amount", - "stateId" + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -72404,8 +73694,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderId": { - "description": "Unique identity of an order.", + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -72413,79 +73713,67 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" + "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" }, - "validationData": { - "type": "object" + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" }, - "stateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -72498,8 +73786,7 @@ }, "relationships": { "properties": { - "stateMachineState": { - "description": "Current payment transaction state (e.g., open, paid, cancelled)", + "country": { "properties": { "links": { "type": "object", @@ -72507,7 +73794,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, @@ -72516,19 +73803,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "order": { + "countryState": { "properties": { "links": { "type": "object", @@ -72536,7 +73823,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" } } }, @@ -72545,20 +73832,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "paymentMethod": { - "description": "Payment method used for this transaction", + "order": { "properties": { "links": { "type": "object", @@ -72566,7 +73852,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" } } }, @@ -72575,20 +73861,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "captures": { - "description": "Payment captures for this transaction", + "orderDeliveries": { "properties": { "links": { "type": "object", @@ -72596,7 +73881,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" } } }, @@ -72607,11 +73892,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "order_delivery" }, "id": { "type": "string", - "example": "8856ffdd044d57cd4124a6be5dcea329" + "example": "0ba472de56dd7ba2e7bb878434321e26" } } } @@ -72619,7 +73904,7 @@ }, "type": "object" }, - "primaryOrder": { + "salutation": { "properties": { "links": { "type": "object", @@ -72627,7 +73912,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" } } }, @@ -72636,12 +73921,12 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f3654baea1bb37cbbd3b86e9793c3766" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -72656,14 +73941,16 @@ } ] }, - "OrderTransaction": { + "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", + "countryId", "orderId", - "paymentMethodId", - "amount", - "stateId" + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -72674,8 +73961,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderId": { - "description": "Unique identity of an order.", + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -72683,79 +73980,67 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "validationData": { - "type": "object" + "lastName": { + "description": "Last name of the customer.", + "type": "string" }, - "stateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "street": { + "description": "Street address", + "type": "string" + }, + "zipcode": { + "description": "Zip code of the country.", + "type": "string" + }, + "city": { + "description": "Name of the city.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "department": { + "description": "Name of the department.", + "type": "string" + }, + "title": { + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -72766,32 +74051,29 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current payment transaction state (e.g., open, paid, cancelled)" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" }, "order": { "$ref": "#/components/schemas/Order" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Payment method used for this transaction" - }, - "captures": { - "description": "Payment captures for this transaction", + "orderDeliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderDelivery" } }, - "primaryOrder": { - "$ref": "#/components/schemas/Order" + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "OrderTransactionCaptureJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderCustomerJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -72799,9 +74081,10 @@ { "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "orderId", + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -72812,84 +74095,62 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of order state.", + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", + "email": { + "description": "Email address of the customer.", "type": "string" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" + "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": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" }, "customFields": { "type": "object" }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -72902,7 +74163,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "order": { "properties": { "links": { "type": "object", @@ -72910,7 +74171,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, @@ -72919,19 +74180,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "transaction": { + "customer": { "properties": { "links": { "type": "object", @@ -72939,7 +74200,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, @@ -72948,19 +74209,19 @@ "properties": { "type": { "type": "string", - "example": "order_transaction" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f4d5b76a2418eba4baeabc1ed9142b54" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "refunds": { + "salutation": { "properties": { "links": { "type": "object", @@ -72968,23 +74229,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction_capture_refund" - }, - "id": { - "type": "string", - "example": "0084ff716402199f733f841f5937d3ae" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -72999,13 +74258,14 @@ } ] }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", + "OrderCustomer": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "orderId", + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -73016,84 +74276,62 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of order state.", + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", + "email": { + "description": "Email address of the customer.", "type": "string" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" + "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": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" }, "customFields": { "type": "object" }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -73104,23 +74342,20 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "order": { + "$ref": "#/components/schemas/Order" }, - "transaction": { - "$ref": "#/components/schemas/OrderTransaction" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "refunds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "OrderTransactionCaptureRefundJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderDeliveryJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -73128,9 +74363,12 @@ { "required": [ "id", - "captureId", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "amount" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -73141,29 +74379,51 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { - "description": "Unique identity of order state.", + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", + "type": "string", + "format": "date-time" }, - "amount": { + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" + }, + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -73236,6 +74496,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -73243,7 +74504,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" } } }, @@ -73264,7 +74525,7 @@ }, "type": "object" }, - "transactionCapture": { + "order": { "properties": { "links": { "type": "object", @@ -73272,7 +74533,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" } } }, @@ -73281,12 +74542,72 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56b70ce76ce8e9bfbaf80ea040d456b5" + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "shippingOrderAddress": { + "description": "Shipping address for this delivery", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "39a8592767b8b6a5d6b1dbc47e4058ca" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "description": "Shipping method used for this delivery", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } @@ -73294,6 +74615,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -73301,7 +74623,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" } } }, @@ -73312,7 +74634,7 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund_position" + "example": "order_delivery_position" }, "id": { "type": "string", @@ -73323,6 +74645,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -73332,13 +74683,16 @@ } ] }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", + "OrderDelivery": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "captureId", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "amount" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -73349,29 +74703,51 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { - "description": "Unique identity of order state.", + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", + "type": "string", + "format": "date-time" }, - "amount": { + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" + }, + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -73442,22 +74818,35 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, - "transactionCapture": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "order": { + "$ref": "#/components/schemas/Order" + }, + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderDeliveryPosition" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" }, - "OrderTransactionCaptureRefundPositionJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderDeliveryPositionJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -73465,9 +74854,8 @@ { "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -73478,17 +74866,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundId": { - "description": "Unique identity of order transaction capture refund.", + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundVersionId": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { - "description": "Unique identity of order line item.", + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -73496,20 +74884,7 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" - }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" - }, - "quantity": { - "description": "Quantity of line item to be refunded.", - "type": "integer", - "format": "int64" - }, - "amount": { + "price": { "required": [ "unitPrice", "totalPrice", @@ -73566,6 +74941,21 @@ }, "type": "object" }, + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" + }, + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "quantity": { + "description": "Number of items of each product.", + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -73581,7 +74971,7 @@ }, "relationships": { "properties": { - "orderLineItem": { + "orderDelivery": { "properties": { "links": { "type": "object", @@ -73589,7 +74979,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, @@ -73598,19 +74988,19 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "473c50bdac32ac0dc66364d121260dce" } } } }, "type": "object" }, - "orderTransactionCaptureRefund": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -73618,7 +75008,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" } } }, @@ -73627,12 +75017,12 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8e55f83da36c39263717541ec1f18de7" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } @@ -73647,13 +75037,12 @@ } ] }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", + "OrderDeliveryPosition": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -73664,17 +75053,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundId": { - "description": "Unique identity of order transaction capture refund.", + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundVersionId": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { - "description": "Unique identity of order line item.", + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -73682,20 +75071,7 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" - }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" - }, - "quantity": { - "description": "Quantity of line item to be refunded.", - "type": "integer", - "format": "int64" - }, - "amount": { + "price": { "required": [ "unitPrice", "totalPrice", @@ -73752,6 +75128,21 @@ }, "type": "object" }, + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" + }, + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "quantity": { + "description": "Number of items of each product.", + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -73765,16 +75156,17 @@ "format": "date-time", "readOnly": true }, + "orderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" + }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" - }, - "orderTransactionCaptureRefund": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "type": "object" }, - "OrderWarehouseGroupJsonApi": { + "OrderLineItemJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -73783,7 +75175,12 @@ "required": [ "id", "orderId", - "warehouseGroupId" + "identifier", + "quantity", + "label", + "price", + "children", + "states" ], "properties": { "id": { @@ -73795,214 +75192,174 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "warehouseGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "order": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" - } - } - } - }, - "type": "object" - }, - "warehouseGroup": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1768e3071b62161d415e0c24332055ed" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderWarehouseGroup": { - "required": [ - "id", - "orderId", - "warehouseGroupId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "warehouseGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "warehouseGroup": { - "$ref": "#/components/schemas/WarehouseGroup" - } - }, - "type": "object" - }, - "PaymentMethodJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { + }, + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { - "description": "Unique identity of plugin.", + "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "handlerIdentifier": { - "description": "Internal field that contains system identifier details for payment methods like Paypal.", - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "promotionId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "distinguishableName": { + "parentId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, - "position": { - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" + }, + "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, - "active": { - "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "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" }, - "afterOrderEnabled": { - "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, - "customFields": { + "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" + }, + "position": { + "description": "Position of line items placed in an order.", + "type": "integer", + "format": "int64" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, "type": "object" }, - "availabilityRuleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priceDefinition": { + "type": "object" }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" }, - "formattedHandlerIdentifier": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" }, - "technicalName": { + "description": { + "description": "Description of line items in an order.", "type": "string" }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] + }, + "customFields": { + "type": "object" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true }, "createdAt": { "type": "string", @@ -74014,12 +75371,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "subscriptions": { + "returns": { "properties": { "links": { "type": "object", @@ -74027,7 +75381,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" } } }, @@ -74038,11 +75392,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "7fff84525c6516919851a9005373f87e" } } } @@ -74050,7 +75404,7 @@ }, "type": "object" }, - "quoteTransactions": { + "state": { "properties": { "links": { "type": "object", @@ -74058,85 +75412,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c960fb2e8b7ef26229da52c7f7775e13" - } - } - } - } - }, - "type": "object" - }, - "organizations": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "d9811f03b461a380c0d6b4a497dbac37" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "state_machine_state" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } @@ -74148,8 +75438,8 @@ }, "relationships": { "properties": { - "media": { - "description": "Payment method logo or icon image", + "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -74157,7 +75447,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" } } }, @@ -74171,14 +75461,14 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, - "availabilityRule": { + "order": { "properties": { "links": { "type": "object", @@ -74186,7 +75476,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" } } }, @@ -74195,19 +75485,20 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9fbb7961d1cb158094924c679e1b302c" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "salesChannelDefaultAssignments": { + "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -74215,30 +75506,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "plugin": { + "promotion": { "properties": { "links": { "type": "object", @@ -74246,7 +75535,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" } } }, @@ -74255,19 +75544,20 @@ "properties": { "type": { "type": "string", - "example": "plugin" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "a24bcf2198b1b13ad985304483f7f324" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "customers": { + "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -74275,7 +75565,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" } } }, @@ -74286,11 +75576,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "order_delivery_position" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "76d4619a36f864b08f57415baaa685ec" } } } @@ -74298,7 +75588,7 @@ }, "type": "object" }, - "orderTransactions": { + "orderTransactionCaptureRefundPositions": { "properties": { "links": { "type": "object", @@ -74306,7 +75596,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" } } }, @@ -74317,11 +75607,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction" + "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", - "example": "3bdb6a464fb3330bd1935325493c5f2c" + "example": "c330b64e5adc1e48e07a78aa79e5b27a" } } } @@ -74329,7 +75619,8 @@ }, "type": "object" }, - "salesChannels": { + "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -74337,7 +75628,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" } } }, @@ -74348,11 +75639,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "order_line_item_download" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } @@ -74360,7 +75651,7 @@ }, "type": "object" }, - "appPaymentMethod": { + "parent": { "properties": { "links": { "type": "object", @@ -74368,7 +75659,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" } } }, @@ -74377,12 +75668,43 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } } } } @@ -74394,77 +75716,199 @@ } }, "type": "object" - } - ] - }, - "PaymentMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pluginId": { - "description": "Unique identity of plugin.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + } + ] + }, + "OrderLineItem": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "identifier", + "quantity", + "label", + "price", + "children", + "states" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "description": "Unique identity of order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" + }, + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" + }, + "quantity": { + "description": "Number of items of product.", + "type": "integer", + "format": "int64" + }, + "label": { + "description": "It is a typical product name given to the line item.", + "type": "string" + }, + "payload": { + "type": "object" + }, + "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", + "type": "boolean" + }, + "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", + "type": "boolean" + }, + "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" + }, + "position": { + "description": "Position of line items placed in an order.", + "type": "integer", + "format": "int64" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" }, - "handlerIdentifier": { - "description": "Internal field that contains system identifier details for payment methods like Paypal.", - "type": "string" + "priceDefinition": { + "type": "object" }, - "name": { - "type": "string" + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" }, - "distinguishableName": { - "type": "string", - "readOnly": true + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" }, "description": { + "description": "Description of line items in an order.", "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" + "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" }, - "availabilityRuleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "formattedHandlerIdentifier": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "technicalName": { - "type": "string" - }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true }, "createdAt": { "type": "string", @@ -74476,12 +75920,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "subscriptions": { + "returns": { "properties": { "links": { "type": "object", @@ -74489,7 +75930,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" } } }, @@ -74500,11 +75941,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "7fff84525c6516919851a9005373f87e" } } } @@ -74512,7 +75953,7 @@ }, "type": "object" }, - "quoteTransactions": { + "state": { "properties": { "links": { "type": "object", @@ -74520,85 +75961,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c960fb2e8b7ef26229da52c7f7775e13" - } - } - } - } - }, - "type": "object" - }, - "organizations": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_organization" - }, - "id": { - "type": "string", - "example": "d9811f03b461a380c0d6b4a497dbac37" - } - } - } - } - }, - "type": "object" - }, - "b2bPendingOrders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "state_machine_state" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" - } + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } @@ -74608,48 +75985,54 @@ }, "type": "object" }, - "media": { + "cover": { "$ref": "#/components/schemas/Media", - "description": "Payment method logo or icon image" + "description": "Line item image or thumbnail" }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "order": { + "$ref": "#/components/schemas/Order" }, - "salesChannelDefaultAssignments": { + "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/SalesChannel" + "$ref": "#/components/schemas/OrderDeliveryPosition" } }, - "plugin": { - "$ref": "#/components/schemas/Plugin" - }, - "customers": { + "orderTransactionCaptureRefundPositions": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } }, - "orderTransactions": { + "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } }, - "salesChannels": { + "parent": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/OrderLineItem" } - }, - "appPaymentMethod": { - "$ref": "#/components/schemas/AppPaymentMethod" } }, "type": "object" }, - "PluginJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderLineItemDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -74657,93 +76040,231 @@ { "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "orderLineItemId", + "mediaId", + "position", + "accessGranted" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "baseClass": { - "description": "Name of the new class that extends from Shopware's abstract Plugin class.", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of the plugin.", - "type": "string" + "orderLineItemId": { + "description": "Unique identity of Order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "composerName": { - "description": "Name of the composer package name.", - "type": "string" + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "autoload": { - "type": "object" + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "description": "When boolean value is `true`, the plugin is available.", - "type": "boolean" + "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" }, - "managedByComposer": { - "description": "A property to check whether it is installed via composer or not.", + "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "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" + "customFields": { + "type": "object" }, - "version": { - "description": "Version of the plugin.", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "upgradeVersion": { - "description": "Update version available for upgrading plugins.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "installedAt": { - "description": "Date and time when the plugin was installed.", + "relationships": { + "properties": { + "orderLineItem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "72c0cccf44b384eb8f91e0f7074252f8" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "description": "Unique identity of Order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "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": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "OrderProductWarehouseJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "productId", + "warehouseId" + ], + "properties": { + "id": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "upgradedAt": { - "description": "Date and time when the plugin was upgraded.", + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "label": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerLink": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "supportLink": { - "type": "string" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -74755,12 +76276,38 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "paymentMethods": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "product": { "properties": { "links": { "type": "object", @@ -74768,23 +76315,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "warehouse": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "372d30dd2849813ef674855253900679" } } } @@ -74799,97 +76373,45 @@ } ] }, - "Plugin": { - "description": "Added since version: 6.0.0.0", + "OrderProductWarehouse": { "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "orderId", + "productId", + "warehouseId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "baseClass": { - "description": "Name of the new class that extends from Shopware's abstract Plugin class.", - "type": "string" - }, - "name": { - "description": "Unique name of the plugin.", - "type": "string" - }, - "composerName": { - "description": "Name of the composer package name.", - "type": "string" - }, - "autoload": { - "type": "object" - }, - "active": { - "description": "When boolean value is `true`, the plugin is available.", - "type": "boolean" - }, - "managedByComposer": { - "description": "A property to check whether it is installed via composer or not.", - "type": "boolean" - }, - "path": { - "description": "A relative URL to the plugin.", - "type": "string" - }, - "author": { - "description": "Creator of the plugin.", - "type": "string" - }, - "copyright": { - "description": "Legal rights on the created plugin.", - "type": "string" - }, - "license": { - "description": "Software license's like MIT, etc.", - "type": "string" - }, - "version": { - "description": "Version of the plugin.", - "type": "string" - }, - "upgradeVersion": { - "description": "Update version available for upgrading plugins.", - "type": "string" - }, - "installedAt": { - "description": "Date and time when the plugin was installed.", + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "upgradedAt": { - "description": "Date and time when the plugin was upgraded.", + "orderId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderVersionId": { "type": "string", - "readOnly": true - }, - "label": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerLink": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "supportLink": { - "type": "string" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -74901,20 +76423,19 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "order": { + "$ref": "#/components/schemas/Order" }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } + "product": { + "$ref": "#/components/schemas/Product" + }, + "warehouse": { + "$ref": "#/components/schemas/Warehouse" } }, "type": "object" }, - "ProductJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderReturnJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -74922,11 +76443,10 @@ { "required": [ "id", - "taxId", - "price", - "productNumber", - "stock", - "name" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { @@ -74937,321 +76457,137 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productManufacturerVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxId": { - "description": "Unique identity of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "coverId": { - "description": "Unique identity of a ProductMedia item used as product cover.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productMediaVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "description": "Unique identity of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "featureSetId": { - "description": "Unique identity of feature set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductId": { - "description": "Unique identity of canonical product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", - "type": "string" - }, - "restockTime": { - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", - "type": "integer", - "format": "int64" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "active": { - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", - "type": "boolean" - }, - "available": { - "description": "Indicates weather the product is available or not.", - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" - }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stock": { - "description": "Indicates the number of products available.", - "type": "integer", - "format": "int64" - }, - "variation": { - "type": "array", - "items": { - "type": "string" - } - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "variantListingConfig": { - "type": "object" - }, - "variantRestrictions": { - "type": "object" - }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" - }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" - }, - "purchaseSteps": { - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" - }, - "referenceUnit": { - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", - "type": "number", - "format": "float" - }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" - }, - "purchasePrices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" - }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" - }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" - }, - "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" - }, - "length": { - "description": "The length of the product.", - "type": "number", - "format": "float" - }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", - "type": "string", - "format": "date-time" - }, - "ratingAverage": { - "description": "Average of all the ratings.", - "type": "number", - "format": "float", - "readOnly": true - }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } }, - "readOnly": true + "type": "object" }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } }, - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFieldSetSelectionActive": { - "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", - "type": "boolean" - }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaDescription": { - "type": "string" + "type": "object" }, - "name": { - "type": "string" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "keywords": { + "returnNumber": { "type": "string" }, - "description": { - "type": "string" + "requestedAt": { + "type": "string", + "format": "date-time" }, - "metaTitle": { - "type": "string" + "amountTotal": { + "type": "number", + "format": "float" }, - "packUnit": { - "type": "string" + "amountNet": { + "type": "number", + "format": "float" }, - "packUnitPlural": { + "internalComment": { "type": "string" }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "customSearchKeywords": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", + "createdById": { "type": "string", - "enum": [ - "physical", - "digital" - ] + "pattern": "^[0-9a-f]{32}$" }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -75263,12 +76599,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { + "relationships": { "properties": { - "customPrice": { + "order": { "properties": { "links": { "type": "object", @@ -75276,30 +76609,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "subscriptionPlans": { + "state": { "properties": { "links": { "type": "object", @@ -75307,30 +76638,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" }, - "warehouseGroups": { + "createdBy": { "properties": { "links": { "type": "object", @@ -75338,30 +76667,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "warehouses": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -75369,30 +76696,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, - "orderWarehouses": { + "lineItems": { "properties": { "links": { "type": "object", @@ -75400,7 +76725,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" } } }, @@ -75411,53 +76736,342 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "5331369e2f71d048521bd35d80975314" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderReturn": { + "required": [ + "id", + "orderId", + "stateId", + "returnNumber", + "requestedAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "returnNumber": { + "type": "string" + }, + "requestedAt": { + "type": "string", + "format": "date-time" + }, + "amountTotal": { + "type": "number", + "format": "float" + }, + "amountNet": { + "type": "number", + "format": "float" + }, + "internalComment": { + "type": "string" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "state": { + "$ref": "#/components/schemas/StateMachineState" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + }, + "type": "object" + }, + "OrderReturnLineItemJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" }, - "reviewSummaries": { + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "search": { + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, "type": "object" - }, - "quoteLineItems": { + } + }, + "type": "object" + }, + "refundAmount": { + "type": "number", + "format": "float" + }, + "restockQuantity": { + "type": "integer", + "format": "int64" + }, + "internalComment": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "reason": { "properties": { "links": { "type": "object", @@ -75465,30 +77079,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return_line_item_reason" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "40bea8d637cdf2c1b07fcf0630482b73" } } } }, "type": "object" }, - "shoppingListLineItems": { + "state": { "properties": { "links": { "type": "object", @@ -75496,30 +77108,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list_line_item" - }, - "id": { - "type": "string", - "example": "ce593c6d1db236f22dc387a2ee20dfd6" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" }, - "employeeWishlists": { + "return": { "properties": { "links": { "type": "object", @@ -75527,30 +77137,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_employee_wishlist_product" - }, - "id": { - "type": "string", - "example": "e91afc4e24376c8b995cece3ce354b4e" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" } } } }, "type": "object" }, - "individualPricings": { + "lineItem": { "properties": { "links": { "type": "object", @@ -75558,23 +77166,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/individualPricings" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_individual_pricing" - }, - "id": { - "type": "string", - "example": "5246e417af07e49dc4961c49d4ad6c75" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "867cf1ff92974922abc5d5b045b4a2d8" } } } @@ -75583,11 +77189,192 @@ } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderReturnLineItem": { + "required": [ + "id", + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderReturnVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "refundAmount": { + "type": "number", + "format": "float" + }, + "restockQuantity": { + "type": "integer", + "format": "int64" + }, + "internalComment": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "reason": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "state": { + "$ref": "#/components/schemas/StateMachineState" + }, + "return": { + "$ref": "#/components/schemas/OrderReturn" + }, + "lineItem": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "type": "object" + }, + "OrderReturnLineItemReasonJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "reasonKey" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonKey": { + "type": "string" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" }, "relationships": { "properties": { - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "lineItems": { "properties": { "links": { "type": "object", @@ -75595,7 +77382,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" + "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" } } }, @@ -75606,82 +77393,215 @@ "properties": { "type": { "type": "string", - "example": "product_download" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderReturnLineItemReason": { + "required": [ + "id", + "reasonKey" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonKey": { + "type": "string" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + }, + "type": "object" + }, + "OrderTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "orderId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "OrderTransactionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "description": "Unique identity of an order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" }, - "parent": { - "description": "Unique identity of the product.", + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "children": { - "description": "Product variants that inherit from this parent product", + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "deliveryTime": { - "description": "Estimated delivery time for the product", + } + }, + "type": "object" + }, + "validationData": { + "type": "object" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -75689,7 +77609,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" } } }, @@ -75698,20 +77618,19 @@ "properties": { "type": { "type": "string", - "example": "delivery_time" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "tax": { - "description": "Tax configuration (rate and calculation rules)", + "order": { "properties": { "links": { "type": "object", @@ -75719,7 +77638,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tax" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" } } }, @@ -75728,20 +77647,20 @@ "properties": { "type": { "type": "string", - "example": "tax" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "manufacturer": { - "description": "Product manufacturer or brand information", + "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -75749,7 +77668,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" } } }, @@ -75758,20 +77677,20 @@ "properties": { "type": { "type": "string", - "example": "product_manufacturer" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c2904bca62b22443d6cf5e9d89cab204" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, - "unit": { - "description": "Product unit of measure (e.g., piece, liter, kg)", + "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -75779,29 +77698,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/unit" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "unit" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3e34bdebd9bd5edda27e8728904a2552" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture" + }, + "id": { + "type": "string", + "example": "8856ffdd044d57cd4124a6be5dcea329" + } } } } }, "type": "object" }, - "cover": { - "description": "Main product image displayed in listings and detail pages", + "primaryOrder": { "properties": { "links": { "type": "object", @@ -75809,7 +77729,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" } } }, @@ -75818,79 +77738,273 @@ "properties": { "type": { "type": "string", - "example": "product_media" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "f3654baea1bb37cbbd3b86e9793c3766" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransaction": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "description": "Unique identity of an order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" }, - "featureSet": { + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "validationData": { + "type": "object" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" + }, + "captures": { + "description": "Payment captures for this transaction", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" + } + }, + "type": "object" + }, + "OrderTransactionCaptureJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/featureSet" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_feature_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "cmsPage": { - "description": "Custom CMS page layout for the product detail page", + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "canonicalProduct": { - "description": "Canonical product reference for variant consolidation and SEO purposes", + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -75898,7 +78012,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" } } }, @@ -75907,83 +78021,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "023995a50b56c0de077323e958b2bbcd" - } - } - } - }, - "type": "object" - }, - "prices": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/prices" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_price" - }, - "id": { - "type": "string", - "example": "afae32efe0f84fece3f96b377b768b33" - } - } - } - } - }, - "type": "object" - }, - "media": { - "description": "Product images and media gallery", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/media" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", + "transaction": { "properties": { "links": { "type": "object", @@ -75991,30 +78041,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/crossSellings" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_cross_selling" - }, - "id": { - "type": "string", - "example": "89936e14544d1b403cecef938101b6b0" - } + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, - "crossSellingAssignedProducts": { + "refunds": { "properties": { "links": { "type": "object", @@ -76022,7 +78070,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, @@ -76033,20 +78081,263 @@ "properties": { "type": { "type": "string", - "example": "product_cross_selling_assigned_products" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", - "example": "5ee26b69e515f51ece26912961283b6d" + "example": "0084ff716402199f733f841f5937d3ae" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + }, + "type": "object" + }, + "OrderTransactionCaptureRefundJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "captureId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "description": "Unique identity of order transaction capture.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -76054,30 +78345,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_configurator_setting" - }, - "id": { - "type": "string", - "example": "c0827fee13725d41f1fd7e292243f5aa" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "visibilities": { + "transactionCapture": { "properties": { "links": { "type": "object", @@ -76085,30 +78374,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/visibilities" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_visibility" - }, - "id": { - "type": "string", - "example": "63226fcdfe3316ec1237ef07a8fe6732" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56b70ce76ce8e9bfbaf80ea040d456b5" } } } }, "type": "object" }, - "searchKeywords": { + "positions": { "properties": { "links": { "type": "object", @@ -76116,7 +78403,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" } } }, @@ -76127,178 +78414,276 @@ "properties": { "type": { "type": "string", - "example": "product_search_keyword" + "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", - "example": "effbcffaacb8111b531f15e6f4c796d1" + "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "captureId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "description": "Unique identity of order transaction capture.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transactionCapture": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + }, + "type": "object" + }, + "OrderTransactionCaptureRefundPositionJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "refundId", + "orderLineItemId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "description": "Unique identity of order transaction capture refund.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "description": "Unique identity of order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "quantity": { + "description": "Quantity of line item to be refunded.", + "type": "integer", + "format": "int64" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/productReviews" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review" - }, - "id": { - "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" - } - } - } - } - }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { "type": "object" }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/mainCategories" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "main_category" - }, - "id": { - "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" - } - } - } - } - }, + "taxRules": { "type": "object" }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } - } - } - } - }, + "referencePrice": { "type": "object" }, - "orderLineItems": { + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "wishlists": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/wishlists" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_wishlist_product" - }, - "id": { - "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -76306,63 +78691,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/options" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "93da65a9fd0004d9477aeac024e08e15" - } - } - } - } - }, - "type": "object" - }, - "properties": { - "description": "Product properties and characteristics for filtering", - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/properties" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "74693d2fc58b46bd06410f278e39aa71" - } + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "categories": { - "description": "Categories this product is assigned to", + "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", @@ -76370,63 +78720,207 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categories" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" - } - } - } - } - }, - "type": "object" - }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/streams" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { - "type": "string", - "example": "2f6f4768f1c2d7c8f1f54823723f1a70" - } + "example": "order_transaction_capture_refund" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8e55f83da36c39263717541ec1f18de7" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCaptureRefundPosition": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "refundId", + "orderLineItemId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "description": "Unique identity of order transaction capture refund.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "description": "Unique identity of order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "quantity": { + "description": "Quantity of line item to be refunded.", + "type": "integer", + "format": "int64" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "orderTransactionCaptureRefund": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + }, + "type": "object" + }, + "OrderWarehouseGroupJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "warehouseGroupId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "warehouseGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { "properties": { "links": { "type": "object", @@ -76434,62 +78928,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "7f0702d3a90d965b8c9158c451f43fdb" - } - } - } - } - }, - "type": "object" - }, - "tags": { - "description": "Tags for organizing and filtering products", - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { + "type": "string", + "example": "order" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "customFieldSets": { + "warehouseGroup": { "properties": { "links": { "type": "object", @@ -76497,23 +78957,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1768e3071b62161d415e0c24332055ed" } } } @@ -76528,15 +78986,11 @@ } ] }, - "Product": { - "description": "Added since version: 6.0.0.0", + "OrderWarehouseGroup": { "required": [ "id", - "taxId", - "price", - "productNumber", - "stock", - "name" + "orderId", + "warehouseGroupId" ], "properties": { "id": { @@ -76547,322 +79001,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productManufacturerVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxId": { - "description": "Unique identity of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "coverId": { - "description": "Unique identity of a ProductMedia item used as product cover.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productMediaVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "description": "Unique identity of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "featureSetId": { - "description": "Unique identity of feature set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductId": { - "description": "Unique identity of canonical product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductVersionId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "warehouseGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", - "type": "string" - }, - "restockTime": { - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", - "type": "integer", - "format": "int64" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "active": { - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", - "type": "boolean" - }, - "available": { - "description": "Indicates weather the product is available or not.", - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" - }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stock": { - "description": "Indicates the number of products available.", - "type": "integer", - "format": "int64" - }, - "variation": { - "type": "array", - "items": { - "type": "string" - } - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "variantListingConfig": { - "type": "object" - }, - "variantRestrictions": { - "type": "object" - }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" - }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" - }, - "purchaseSteps": { - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" - }, - "referenceUnit": { - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", - "type": "number", - "format": "float" - }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" - }, - "purchasePrices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" - }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" - }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" - }, - "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" - }, - "length": { - "description": "The length of the product.", - "type": "number", - "format": "float" - }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", - "type": "string", - "format": "date-time" - }, - "ratingAverage": { - "description": "Average of all the ratings.", - "type": "number", - "format": "float", - "readOnly": true - }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFieldSetSelectionActive": { - "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", - "type": "boolean" - }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "packUnit": { - "type": "string" - }, - "packUnitPlural": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "customSearchKeywords": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -76873,201 +79023,567 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "order": { + "$ref": "#/components/schemas/Order" }, - "extensions": { + "warehouseGroup": { + "$ref": "#/components/schemas/WarehouseGroup" + } + }, + "type": "object" + }, + "PaymentMethodJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "name" + ], "properties": { - "customPrice": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", + "type": "string" + }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" + }, + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "technicalName": { + "type": "string" + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "links": { - "type": "object", + "subscriptions": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } } } - } - } - }, - "type": "object" - }, - "subscriptionPlans": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "quoteTransactions": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_transaction" + }, + "id": { + "type": "string", + "example": "c960fb2e8b7ef26229da52c7f7775e13" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" + "organizations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "d9811f03b461a380c0d6b4a497dbac37" + } + } } } - } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, - "warehouseGroups": { + "relationships": { "properties": { - "links": { - "type": "object", + "media": { + "description": "Payment method logo or icon image", "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "availabilityRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" + } } } - } - } - }, - "type": "object" - }, - "warehouses": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" + "plugin": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "plugin" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a24bcf2198b1b13ad985304483f7f324" + } } } - } - } - }, - "type": "object" - }, - "orderWarehouses": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "customers": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_product_warehouse" - }, - "id": { - "type": "string", - "example": "5331369e2f71d048521bd35d80975314" + "orderTransactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "3bdb6a464fb3330bd1935325493c5f2c" + } + } } } - } - } - }, - "type": "object" - }, - "reviewSummaries": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "salesChannels": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" + "appPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" + } } } - } + }, + "type": "object" } }, "type": "object" - }, - "search": { - "type": "object" - }, - "quoteLineItems": { + } + }, + "type": "object" + } + ] + }, + "PaymentMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", + "type": "string" + }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" + }, + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "technicalName": { + "type": "string" + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -77075,7 +79591,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, @@ -77086,11 +79602,11 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "subscription" }, "id": { "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -77098,7 +79614,7 @@ }, "type": "object" }, - "shoppingListLineItems": { + "quoteTransactions": { "properties": { "links": { "type": "object", @@ -77106,7 +79622,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, @@ -77117,11 +79633,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_shopping_list_line_item" + "example": "quote_transaction" }, "id": { "type": "string", - "example": "ce593c6d1db236f22dc387a2ee20dfd6" + "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } @@ -77129,7 +79645,7 @@ }, "type": "object" }, - "employeeWishlists": { + "organizations": { "properties": { "links": { "type": "object", @@ -77137,7 +79653,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, @@ -77148,11 +79664,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_employee_wishlist_product" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "e91afc4e24376c8b995cece3ce354b4e" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -77160,7 +79676,7 @@ }, "type": "object" }, - "individualPricings": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -77168,7 +79684,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/individualPricings" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, @@ -77179,11 +79695,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_individual_pricing" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "5246e417af07e49dc4961c49d4ad6c75" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -77194,179 +79710,306 @@ }, "type": "object" }, - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "media": { + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/SalesChannel" } }, - "parent": { - "$ref": "#/components/schemas/Product", - "description": "Unique identity of the product." + "plugin": { + "$ref": "#/components/schemas/Plugin" }, - "children": { - "description": "Product variants that inherit from this parent product", + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Customer" } }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime", - "description": "Estimated delivery time for the product" + "orderTransactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration (rate and calculation rules)" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer", - "description": "Product manufacturer or brand information" + "appPaymentMethod": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "type": "object" + }, + "PluginJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "unit": { - "$ref": "#/components/schemas/Unit", - "description": "Product unit of measure (e.g., piece, liter, kg)" + { + "required": [ + "id", + "baseClass", + "name", + "autoload", + "version", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" + }, + "name": { + "description": "Unique name of the plugin.", + "type": "string" + }, + "composerName": { + "description": "Name of the composer package name.", + "type": "string" + }, + "autoload": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the plugin is available.", + "type": "boolean" + }, + "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", + "type": "boolean" + }, + "path": { + "description": "A relative URL to the plugin.", + "type": "string" + }, + "author": { + "description": "Creator of the plugin.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created plugin.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "upgradeVersion": { + "description": "Update version available for upgrading plugins.", + "type": "string" + }, + "installedAt": { + "description": "Date and time when the plugin was installed.", + "type": "string", + "format": "date-time" + }, + "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", + "type": "string", + "format": "date-time" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "manufacturerLink": { + "type": "string" + }, + "supportLink": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Plugin": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "baseClass", + "name", + "autoload", + "version", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cover": { - "$ref": "#/components/schemas/ProductMedia", - "description": "Main product image displayed in listings and detail pages" + "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" }, - "featureSet": { - "$ref": "#/components/schemas/ProductFeatureSet" + "name": { + "description": "Unique name of the plugin.", + "type": "string" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "Custom CMS page layout for the product detail page" + "composerName": { + "description": "Name of the composer package name.", + "type": "string" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product", - "description": "Canonical product reference for variant consolidation and SEO purposes" + "autoload": { + "type": "object" }, - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } + "active": { + "description": "When boolean value is `true`, the plugin is available.", + "type": "boolean" }, - "media": { - "description": "Product images and media gallery", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", + "type": "boolean" }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } + "path": { + "description": "A relative URL to the plugin.", + "type": "string" }, - "crossSellingAssignedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } + "author": { + "description": "Creator of the plugin.", + "type": "string" }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } + "copyright": { + "description": "Legal rights on the created plugin.", + "type": "string" }, - "visibilities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" }, - "searchKeywords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } + "version": { + "description": "Version of the plugin.", + "type": "string" }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "upgradeVersion": { + "description": "Update version available for upgrading plugins.", + "type": "string" }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "installedAt": { + "description": "Date and time when the plugin was installed.", + "type": "string", + "format": "date-time" }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", + "type": "string", + "format": "date-time" }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "wishlists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } + "label": { + "type": "string" }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "description": { + "type": "string" }, - "properties": { - "description": "Product properties and characteristics for filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "manufacturerLink": { + "type": "string" }, - "categories": { - "description": "Categories this product is assigned to", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "supportLink": { + "type": "string" }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } + "customFields": { + "type": "object" }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "description": "Tags for organizing and filtering products", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "customFieldSets": { + "translated": { + "type": "object" + }, + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/PaymentMethod" } } }, @@ -81533,7 +84176,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -81643,7 +84291,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -87598,6 +90251,37 @@ } }, "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -88194,6 +90878,37 @@ } }, "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -92412,9 +95127,10 @@ "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", "enum": [ - "frontend.detail.page", "frontend.navigation.page", - "frontend.landing.page" + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" ] }, "pathInfo": { @@ -92560,9 +95276,10 @@ "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", "enum": [ - "frontend.detail.page", "frontend.navigation.page", - "frontend.landing.page" + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" ] }, "pathInfo": { @@ -105171,87 +107888,75 @@ ], "additionalProperties": false }, - "Price": { + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "MeasurementUnits": { "type": "object", - "description": "Price object", + "description": "Configuration of the measurement system", "properties": { - "currencyId": { + "system": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "listPrice": { - "description": "", + "units": { "type": "object", + "description": "Units used in the measurement system.", "properties": { - "currencyId": { + "length": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { + "weight": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "required": [ - "gross", - "net", - "linked" - ] + } } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] + } }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", @@ -105377,32 +108082,6 @@ } ] }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, "MediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -105436,6 +108115,40 @@ } } }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } + } + } + }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -106142,83 +108855,87 @@ "field" ] }, - "MeasurementUnits": { + "Price": { "type": "object", - "description": "Configuration of the measurement system", + "description": "Price object", "properties": { - "system": { + "currencyId": { "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "pattern": "^[0-9a-f]{32}$" }, - "units": { + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", - "description": "Units used in the measurement system.", "properties": { - "length": { + "currencyId": { "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "pattern": "^[0-9a-f]{32}$" }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } - } - } - }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" }, - "data": { - "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" + "required": [ + "gross", + "net", + "linked" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } + "required": [ + "gross", + "net", + "linked" + ] } - } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] }, "ConsentState": { "type": "object", @@ -106278,59 +108995,6 @@ } } }, - "CustomPricingResponse": { - "type": "object", - "required": [ - "success", - "data" - ], - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "array", - "items": { - "type": "object", - "required": [ - "entities", - "errors" - ], - "properties": { - "entities": { - "type": "array", - "maxItems": 1, - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "errors": { - "type": "array", - "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", - "items": { - "type": "string" - } - } - } - } - }, - "extensions": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - }, "CustomPricingDeleteOperation": { "type": "object", "required": [ @@ -106382,6 +109046,64 @@ } } }, + "CustomPricingUpsertOperation": { + "type": "object", + "required": [ + "action", + "payload" + ], + "properties": { + "action": { + "description": "A specific verb defining what operation should be actioned for a specific data record", + "type": "string", + "enum": [ + "upsert" + ] + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object", + "required": [ + "productId", + "prices" + ], + "description": "A definition almost symmetric with Sync API payload", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "description": "This parameter should be specified, or 'customerGroupId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "description": "This parameter should be specified, or 'customerId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPricingPrice" + } + } + } + } + } + } + }, "CustomPricingPrice": { "type": "object", "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", @@ -106463,57 +109185,52 @@ } } }, - "CustomPricingUpsertOperation": { + "CustomPricingResponse": { "type": "object", "required": [ - "action", - "payload" + "success", + "data" ], "properties": { - "action": { - "description": "A specific verb defining what operation should be actioned for a specific data record", - "type": "string", - "enum": [ - "upsert" - ] + "success": { + "type": "boolean" }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "data": { "type": "array", "items": { "type": "object", - "required": [ - "productId", - "prices" - ], - "description": "A definition almost symmetric with Sync API payload", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "description": "This parameter should be specified, or 'customerGroupId', not both", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "type": "string", - "description": "This parameter should be specified, or 'customerId', not both", - "pattern": "^[0-9a-f]{32}$" + "result": { + "type": "array", + "items": { + "type": "object", + "required": [ + "entities", + "errors" + ], + "properties": { + "entities": { + "type": "array", + "maxItems": 1, + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "errors": { + "type": "array", + "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", + "items": { + "type": "string" + } + } + } + } }, - "price": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPricingPrice" + "type": "object" } } } @@ -106620,6 +109337,171 @@ "description": "Generated summary for the language id" }, "description": "Map of languageId to generated summary string." + }, + "BundleItemProduct": { + "type": "object", + "required": [ + "id", + "productNumber" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "productNumber": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "apiAlias": { + "type": "string", + "readOnly": true + } + } + }, + "BundleProductWrite": { + "type": "object", + "required": [ + "name", + "bundleItems" + ], + "properties": { + "productNumber": { + "type": "string", + "description": "Optional. Omit to let the server reserve a number." + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleItem" + }, + "minItems": 2 + }, + "bundleDiscounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleDiscount" + } + }, + "visibilities": { + "type": "array", + "items": { + "type": "object", + "required": [ + "salesChannelId" + ], + "properties": { + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "type": "integer", + "enum": [ + 1, + 2, + 3 + ] + } + } + } + }, + "customFields": { + "type": "object" + } + } + }, + "BundleProduct": { + "allOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "price": { + "type": "array", + "items": { + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "net": { + "type": "number" + }, + "gross": { + "type": "number" + }, + "linked": { + "type": "boolean" + } + } + } + }, + "stock": { + "type": "integer" + }, + "sales": { + "type": "integer" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "cover": { + "type": "object" + }, + "media": { + "type": "array", + "items": { + "type": "object" + } + }, + "apiAlias": { + "type": "string", + "readOnly": true + } + } + } + ] } }, "responses": { @@ -107146,6 +110028,18 @@ "name": "B2b Permission", "description": "The endpoint for operations on B2b Permission" }, + { + "name": "Product", + "description": "The endpoint for operations on Product" + }, + { + "name": "Bundle Discount", + "description": "The endpoint for operations on Bundle Discount" + }, + { + "name": "Bundle Item", + "description": "The endpoint for operations on Bundle Item" + }, { "name": "Category", "description": "The endpoint for operations on Category" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index ec53ba9..e415aab 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -11,7 +11,6 @@ "/_action/share-config/upload/{entity}", "/_action/text-to-image/generate", "/_action/update-employee", - "/_action/user/logout", "/_proxy-quote/{salesChannelId}", "/advanced-search-action", "/advanced-search-action-search-term", @@ -59,6 +58,8 @@ "/aggregate/b2b-employee", "/aggregate/b2b-order-employee", "/aggregate/b2b-permission", + "/aggregate/bundle-discount", + "/aggregate/bundle-item", "/aggregate/custom-price", "/aggregate/customer-specific-features", "/aggregate/media-ai-tag", @@ -97,7 +98,6 @@ "/aggregate/warehouse-group", "/api/_action/generate-review-summary", "/api/_admin/rule-builder-preview/{orderId}", - "/app-system/shop/verify", "/b2b-business-partner", "/b2b-business-partner/{id}", "/b2b-components-advanced-product-catalogs", @@ -142,6 +142,10 @@ "/b2b-order-employee/{id}", "/b2b-permission", "/b2b-permission/{id}", + "/bundle-discount", + "/bundle-discount/{id}", + "/bundle-item", + "/bundle-item/{id}", "/custom-price", "/custom-price/{id}", "/customer-specific-features", @@ -158,6 +162,11 @@ "/order-return/{id}", "/order-warehouse-group", "/order-warehouse-group/{id}", + "/product-bundle", + "/product-bundle/search", + "/product-bundle/search-ids", + "/product-bundle/{id}", + "/product-bundle/{id}/clone", "/product-review-summary", "/product-review-summary/{id}", "/product-warehouse", @@ -208,6 +217,8 @@ "/search/b2b-employee", "/search/b2b-order-employee", "/search/b2b-permission", + "/search/bundle-discount", + "/search/bundle-item", "/search/custom-price", "/search/customer-specific-features", "/search/media-ai-tag", @@ -380,6 +391,15 @@ "B2bOrderEmployeeJsonApi", "B2bPermission", "B2bPermissionJsonApi", + "BundleDiscount", + "BundleDiscountJsonApi", + "BundleDiscountRule", + "BundleItem", + "BundleItemJsonApi", + "BundleItemProduct", + "BundleProduct", + "BundleProductWrite", + "BundleVisibility", "Category", "CategoryJsonApi", "CategoryTag",