{ "openapi": "3.1.0", "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", "license": { "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, "version": "6.7.9999999-dev" }, "servers": [ { "url": "http://localhost:8000/api" } ], "paths": { "/acl-role": { "get": { "tags": [ "Acl Role" ], "summary": "List with basic information of Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "getAclRoleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Acl Role resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/acl-role?limit=25" }, "last": { "example": "/acl-role?limit=25&page=11" }, "next": { "example": "/acl-role?limit=25&page=4" }, "prev": { "example": "/acl-role?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Acl Role" ], "summary": "Create a new Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "createAclRole", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" } } } }, "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/acl-role": { "post": { "tags": [ "Acl Role" ], "summary": "Search for the Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "searchAclRole", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/acl-role/{id}": { "get": { "tags": [ "Acl Role" ], "summary": "Detailed information about a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "getAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Acl Role" ], "summary": "Delete a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Acl Role" ], "summary": "Partially update information about a Acl Role resource.", "description": "Available since: 6.0.0.0", "operationId": "updateAclRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the acl_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Acl Role resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" } } } }, "responses": { "200": { "description": "Detail of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AclRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/acl-role": { "post": { "tags": [ "Acl Role" ], "summary": "Aggregate for the Acl Role resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAclRole", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app": { "get": { "tags": [ "App" ], "summary": "List with basic information of App resources.", "description": "Available since: 6.3.1.0", "operationId": "getAppList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/App" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app?limit=25" }, "last": { "example": "/app?limit=25&page=11" }, "next": { "example": "/app?limit=25&page=4" }, "prev": { "example": "/app?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App" ], "summary": "Create a new App resources.", "description": "Available since: 6.3.1.0", "operationId": "createApp", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "responses": { "200": { "description": "Detail of App", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/App" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app": { "post": { "tags": [ "App" ], "summary": "Search for the App resources.", "description": "Available since: 6.3.1.0", "operationId": "searchApp", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of App", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app/{id}": { "get": { "tags": [ "App" ], "summary": "Detailed information about a App resource.", "description": "Available since: 6.3.1.0", "operationId": "getApp", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of App", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/App" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App" ], "summary": "Delete a App resource.", "description": "Available since: 6.3.1.0", "operationId": "deleteApp", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App" ], "summary": "Partially update information about a App resource.", "description": "Available since: 6.3.1.0", "operationId": "updateApp", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "responses": { "200": { "description": "Detail of App", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/App" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app": { "post": { "tags": [ "App" ], "summary": "Aggregate for the App resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateApp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of App", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-action-button": { "get": { "tags": [ "App Action Button" ], "summary": "List with basic information of App Action Button resources.", "description": "Available since: 6.3.1.0", "operationId": "getAppActionButtonList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Action Button resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-action-button?limit=25" }, "last": { "example": "/app-action-button?limit=25&page=11" }, "next": { "example": "/app-action-button?limit=25&page=4" }, "prev": { "example": "/app-action-button?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Action Button" ], "summary": "Create a new App Action Button resources.", "description": "Available since: 6.3.1.0", "operationId": "createAppActionButton", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppActionButton" } } } }, "responses": { "200": { "description": "Detail of AppActionButton", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-action-button": { "post": { "tags": [ "App Action Button" ], "summary": "Search for the App Action Button resources.", "description": "Available since: 6.3.1.0", "operationId": "searchAppActionButton", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-action-button/{id}": { "get": { "tags": [ "App Action Button" ], "summary": "Detailed information about a App Action Button resource.", "description": "Available since: 6.3.1.0", "operationId": "getAppActionButton", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_action_button", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppActionButton", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Action Button" ], "summary": "Delete a App Action Button resource.", "description": "Available since: 6.3.1.0", "operationId": "deleteAppActionButton", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_action_button", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Action Button" ], "summary": "Partially update information about a App Action Button resource.", "description": "Available since: 6.3.1.0", "operationId": "updateAppActionButton", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_action_button", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Action Button resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppActionButton" } } } }, "responses": { "200": { "description": "Detail of AppActionButton", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppActionButton" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-action-button": { "post": { "tags": [ "App Action Button" ], "summary": "Aggregate for the App Action Button resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppActionButton", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-administration-snippet": { "get": { "tags": [ "App Administration Snippet" ], "summary": "List with basic information of App Administration Snippet resources.", "description": "Available since: 6.4.15.0", "operationId": "getAppAdministrationSnippetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Administration Snippet resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-administration-snippet?limit=25" }, "last": { "example": "/app-administration-snippet?limit=25&page=11" }, "next": { "example": "/app-administration-snippet?limit=25&page=4" }, "prev": { "example": "/app-administration-snippet?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Administration Snippet" ], "summary": "Create a new App Administration Snippet resources.", "description": "Available since: 6.4.15.0", "operationId": "createAppAdministrationSnippet", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } }, "responses": { "200": { "description": "Detail of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-administration-snippet": { "post": { "tags": [ "App Administration Snippet" ], "summary": "Search for the App Administration Snippet resources.", "description": "Available since: 6.4.15.0", "operationId": "searchAppAdministrationSnippet", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-administration-snippet/{id}": { "get": { "tags": [ "App Administration Snippet" ], "summary": "Detailed information about a App Administration Snippet resource.", "description": "Available since: 6.4.15.0", "operationId": "getAppAdministrationSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_administration_snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Administration Snippet" ], "summary": "Delete a App Administration Snippet resource.", "description": "Available since: 6.4.15.0", "operationId": "deleteAppAdministrationSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_administration_snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Administration Snippet" ], "summary": "Partially update information about a App Administration Snippet resource.", "description": "Available since: 6.4.15.0", "operationId": "updateAppAdministrationSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_administration_snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Administration Snippet resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } }, "responses": { "200": { "description": "Detail of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-administration-snippet": { "post": { "tags": [ "App Administration Snippet" ], "summary": "Aggregate for the App Administration Snippet resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppAdministrationSnippet", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAdministrationSnippet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-cms-block": { "get": { "tags": [ "App Cms Block" ], "summary": "List with basic information of App Cms Block resources.", "description": "Available since: 6.4.2.0", "operationId": "getAppCmsBlockList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Cms Block resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-cms-block?limit=25" }, "last": { "example": "/app-cms-block?limit=25&page=11" }, "next": { "example": "/app-cms-block?limit=25&page=4" }, "prev": { "example": "/app-cms-block?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Cms Block" ], "summary": "Create a new App Cms Block resources.", "description": "Available since: 6.4.2.0", "operationId": "createAppCmsBlock", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppCmsBlock" } } } }, "responses": { "200": { "description": "Detail of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-cms-block": { "post": { "tags": [ "App Cms Block" ], "summary": "Search for the App Cms Block resources.", "description": "Available since: 6.4.2.0", "operationId": "searchAppCmsBlock", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-cms-block/{id}": { "get": { "tags": [ "App Cms Block" ], "summary": "Detailed information about a App Cms Block resource.", "description": "Available since: 6.4.2.0", "operationId": "getAppCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Cms Block" ], "summary": "Delete a App Cms Block resource.", "description": "Available since: 6.4.2.0", "operationId": "deleteAppCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Cms Block" ], "summary": "Partially update information about a App Cms Block resource.", "description": "Available since: 6.4.2.0", "operationId": "updateAppCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Cms Block resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppCmsBlock" } } } }, "responses": { "200": { "description": "Detail of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-cms-block": { "post": { "tags": [ "App Cms Block" ], "summary": "Aggregate for the App Cms Block resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppCmsBlock", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-flow-action": { "get": { "tags": [ "App Flow Action" ], "summary": "List with basic information of App Flow Action resources.", "description": "Available since: 6.4.10.0", "operationId": "getAppFlowActionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Flow Action resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-flow-action?limit=25" }, "last": { "example": "/app-flow-action?limit=25&page=11" }, "next": { "example": "/app-flow-action?limit=25&page=4" }, "prev": { "example": "/app-flow-action?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Flow Action" ], "summary": "Create a new App Flow Action resources.", "description": "Available since: 6.4.10.0", "operationId": "createAppFlowAction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowAction" } } } }, "responses": { "200": { "description": "Detail of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-flow-action": { "post": { "tags": [ "App Flow Action" ], "summary": "Search for the App Flow Action resources.", "description": "Available since: 6.4.10.0", "operationId": "searchAppFlowAction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-flow-action/{id}": { "get": { "tags": [ "App Flow Action" ], "summary": "Detailed information about a App Flow Action resource.", "description": "Available since: 6.4.10.0", "operationId": "getAppFlowAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Flow Action" ], "summary": "Delete a App Flow Action resource.", "description": "Available since: 6.4.10.0", "operationId": "deleteAppFlowAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Flow Action" ], "summary": "Partially update information about a App Flow Action resource.", "description": "Available since: 6.4.10.0", "operationId": "updateAppFlowAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Flow Action resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowAction" } } } }, "responses": { "200": { "description": "Detail of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-flow-action": { "post": { "tags": [ "App Flow Action" ], "summary": "Aggregate for the App Flow Action resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppFlowAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-flow-event": { "get": { "tags": [ "App Flow Event" ], "summary": "List with basic information of App Flow Event resources.", "description": "Available since: 6.5.2.0", "operationId": "getAppFlowEventList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Flow Event resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-flow-event?limit=25" }, "last": { "example": "/app-flow-event?limit=25&page=11" }, "next": { "example": "/app-flow-event?limit=25&page=4" }, "prev": { "example": "/app-flow-event?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Flow Event" ], "summary": "Create a new App Flow Event resources.", "description": "Available since: 6.5.2.0", "operationId": "createAppFlowEvent", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowEvent" } } } }, "responses": { "200": { "description": "Detail of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-flow-event": { "post": { "tags": [ "App Flow Event" ], "summary": "Search for the App Flow Event resources.", "description": "Available since: 6.5.2.0", "operationId": "searchAppFlowEvent", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-flow-event/{id}": { "get": { "tags": [ "App Flow Event" ], "summary": "Detailed information about a App Flow Event resource.", "description": "Available since: 6.5.2.0", "operationId": "getAppFlowEvent", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_event", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Flow Event" ], "summary": "Delete a App Flow Event resource.", "description": "Available since: 6.5.2.0", "operationId": "deleteAppFlowEvent", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_event", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Flow Event" ], "summary": "Partially update information about a App Flow Event resource.", "description": "Available since: 6.5.2.0", "operationId": "updateAppFlowEvent", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_flow_event", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Flow Event resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowEvent" } } } }, "responses": { "200": { "description": "Detail of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-flow-event": { "post": { "tags": [ "App Flow Event" ], "summary": "Aggregate for the App Flow Event resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppFlowEvent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-prompt": { "get": { "tags": [ "App Mcp Prompt" ], "summary": "List with basic information of App Mcp Prompt resources.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpPromptList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Mcp Prompt resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-mcp-prompt?limit=25" }, "last": { "example": "/app-mcp-prompt?limit=25&page=11" }, "next": { "example": "/app-mcp-prompt?limit=25&page=4" }, "prev": { "example": "/app-mcp-prompt?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Mcp Prompt" ], "summary": "Create a new App Mcp Prompt resources.", "description": "Available since: 6.7.11.0", "operationId": "createAppMcpPrompt", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpPrompt" } } } }, "responses": { "200": { "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-mcp-prompt": { "post": { "tags": [ "App Mcp Prompt" ], "summary": "Search for the App Mcp Prompt resources.", "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpPrompt", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-prompt/{id}": { "get": { "tags": [ "App Mcp Prompt" ], "summary": "Detailed information about a App Mcp Prompt resource.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Mcp Prompt" ], "summary": "Delete a App Mcp Prompt resource.", "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Mcp Prompt" ], "summary": "Partially update information about a App Mcp Prompt resource.", "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Mcp Prompt resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpPrompt" } } } }, "responses": { "200": { "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-mcp-prompt": { "post": { "tags": [ "App Mcp Prompt" ], "summary": "Aggregate for the App Mcp Prompt resources.", "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpPrompt", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-resource": { "get": { "tags": [ "App Mcp Resource" ], "summary": "List with basic information of App Mcp Resource resources.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpResourceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Mcp Resource resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-mcp-resource?limit=25" }, "last": { "example": "/app-mcp-resource?limit=25&page=11" }, "next": { "example": "/app-mcp-resource?limit=25&page=4" }, "prev": { "example": "/app-mcp-resource?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Mcp Resource" ], "summary": "Create a new App Mcp Resource resources.", "description": "Available since: 6.7.11.0", "operationId": "createAppMcpResource", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpResource" } } } }, "responses": { "200": { "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-mcp-resource": { "post": { "tags": [ "App Mcp Resource" ], "summary": "Search for the App Mcp Resource resources.", "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpResource", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-resource/{id}": { "get": { "tags": [ "App Mcp Resource" ], "summary": "Detailed information about a App Mcp Resource resource.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpResource", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Mcp Resource" ], "summary": "Delete a App Mcp Resource resource.", "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpResource", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Mcp Resource" ], "summary": "Partially update information about a App Mcp Resource resource.", "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpResource", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Mcp Resource resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpResource" } } } }, "responses": { "200": { "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpResource" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-mcp-resource": { "post": { "tags": [ "App Mcp Resource" ], "summary": "Aggregate for the App Mcp Resource resources.", "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpResource", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-tool": { "get": { "tags": [ "App Mcp Tool" ], "summary": "List with basic information of App Mcp Tool resources.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpToolList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Mcp Tool resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-mcp-tool?limit=25" }, "last": { "example": "/app-mcp-tool?limit=25&page=11" }, "next": { "example": "/app-mcp-tool?limit=25&page=4" }, "prev": { "example": "/app-mcp-tool?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Mcp Tool" ], "summary": "Create a new App Mcp Tool resources.", "description": "Available since: 6.7.11.0", "operationId": "createAppMcpTool", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpTool" } } } }, "responses": { "200": { "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-mcp-tool": { "post": { "tags": [ "App Mcp Tool" ], "summary": "Search for the App Mcp Tool resources.", "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpTool", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-mcp-tool/{id}": { "get": { "tags": [ "App Mcp Tool" ], "summary": "Detailed information about a App Mcp Tool resource.", "description": "Available since: 6.7.11.0", "operationId": "getAppMcpTool", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Mcp Tool" ], "summary": "Delete a App Mcp Tool resource.", "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpTool", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Mcp Tool" ], "summary": "Partially update information about a App Mcp Tool resource.", "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpTool", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Mcp Tool resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMcpTool" } } } }, "responses": { "200": { "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppMcpTool" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-mcp-tool": { "post": { "tags": [ "App Mcp Tool" ], "summary": "Aggregate for the App Mcp Tool resources.", "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpTool", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-payment-method": { "get": { "tags": [ "App Payment Method" ], "summary": "List with basic information of App Payment Method resources.", "description": "Available since: 6.4.1.0", "operationId": "getAppPaymentMethodList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Payment Method resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-payment-method?limit=25" }, "last": { "example": "/app-payment-method?limit=25&page=11" }, "next": { "example": "/app-payment-method?limit=25&page=4" }, "prev": { "example": "/app-payment-method?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Payment Method" ], "summary": "Create a new App Payment Method resources.", "description": "Available since: 6.4.1.0", "operationId": "createAppPaymentMethod", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppPaymentMethod" } } } }, "responses": { "200": { "description": "Detail of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-payment-method": { "post": { "tags": [ "App Payment Method" ], "summary": "Search for the App Payment Method resources.", "description": "Available since: 6.4.1.0", "operationId": "searchAppPaymentMethod", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-payment-method/{id}": { "get": { "tags": [ "App Payment Method" ], "summary": "Detailed information about a App Payment Method resource.", "description": "Available since: 6.4.1.0", "operationId": "getAppPaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Payment Method" ], "summary": "Delete a App Payment Method resource.", "description": "Available since: 6.4.1.0", "operationId": "deleteAppPaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Payment Method" ], "summary": "Partially update information about a App Payment Method resource.", "description": "Available since: 6.4.1.0", "operationId": "updateAppPaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Payment Method resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppPaymentMethod" } } } }, "responses": { "200": { "description": "Detail of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-payment-method": { "post": { "tags": [ "App Payment Method" ], "summary": "Aggregate for the App Payment Method resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppPaymentMethod", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-script-condition": { "get": { "tags": [ "App Script Condition" ], "summary": "List with basic information of App Script Condition resources.", "description": "Available since: 6.4.10.3", "operationId": "getAppScriptConditionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Script Condition resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-script-condition?limit=25" }, "last": { "example": "/app-script-condition?limit=25&page=11" }, "next": { "example": "/app-script-condition?limit=25&page=4" }, "prev": { "example": "/app-script-condition?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Script Condition" ], "summary": "Create a new App Script Condition resources.", "description": "Available since: 6.4.10.3", "operationId": "createAppScriptCondition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppScriptCondition" } } } }, "responses": { "200": { "description": "Detail of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-script-condition": { "post": { "tags": [ "App Script Condition" ], "summary": "Search for the App Script Condition resources.", "description": "Available since: 6.4.10.3", "operationId": "searchAppScriptCondition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-script-condition/{id}": { "get": { "tags": [ "App Script Condition" ], "summary": "Detailed information about a App Script Condition resource.", "description": "Available since: 6.4.10.3", "operationId": "getAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_script_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Script Condition" ], "summary": "Delete a App Script Condition resource.", "description": "Available since: 6.4.10.3", "operationId": "deleteAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_script_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Script Condition" ], "summary": "Partially update information about a App Script Condition resource.", "description": "Available since: 6.4.10.3", "operationId": "updateAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_script_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Script Condition resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppScriptCondition" } } } }, "responses": { "200": { "description": "Detail of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-script-condition": { "post": { "tags": [ "App Script Condition" ], "summary": "Aggregate for the App Script Condition resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppScriptCondition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppScriptCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-shipping-method": { "get": { "tags": [ "App Shipping Method" ], "summary": "List with basic information of App Shipping Method resources.", "description": "Available since: 6.5.7.0", "operationId": "getAppShippingMethodList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-shipping-method?limit=25" }, "last": { "example": "/app-shipping-method?limit=25&page=11" }, "next": { "example": "/app-shipping-method?limit=25&page=4" }, "prev": { "example": "/app-shipping-method?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Shipping Method" ], "summary": "Create a new App Shipping Method resources.", "description": "Available since: 6.5.7.0", "operationId": "createAppShippingMethod", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-shipping-method": { "post": { "tags": [ "App Shipping Method" ], "summary": "Search for the App Shipping Method resources.", "description": "Available since: 6.5.7.0", "operationId": "searchAppShippingMethod", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-shipping-method/{id}": { "get": { "tags": [ "App Shipping Method" ], "summary": "Detailed information about a App Shipping Method resource.", "description": "Available since: 6.5.7.0", "operationId": "getAppShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Shipping Method" ], "summary": "Delete a App Shipping Method resource.", "description": "Available since: 6.5.7.0", "operationId": "deleteAppShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Shipping Method" ], "summary": "Partially update information about a App Shipping Method resource.", "description": "Available since: 6.5.7.0", "operationId": "updateAppShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Shipping Method resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-shipping-method": { "post": { "tags": [ "App Shipping Method" ], "summary": "Aggregate for the App Shipping Method resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppShippingMethod", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-template": { "get": { "tags": [ "App Template" ], "summary": "List with basic information of App Template resources.", "description": "Available since: 6.3.1.0", "operationId": "getAppTemplateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of App Template resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/app-template?limit=25" }, "last": { "example": "/app-template?limit=25&page=11" }, "next": { "example": "/app-template?limit=25&page=4" }, "prev": { "example": "/app-template?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "App Template" ], "summary": "Create a new App Template resources.", "description": "Available since: 6.3.1.0", "operationId": "createAppTemplate", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/app-template": { "post": { "tags": [ "App Template" ], "summary": "Search for the App Template resources.", "description": "Available since: 6.3.1.0", "operationId": "searchAppTemplate", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of AppTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-template/{id}": { "get": { "tags": [ "App Template" ], "summary": "Detailed information about a App Template resource.", "description": "Available since: 6.3.1.0", "operationId": "getAppTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "App Template" ], "summary": "Delete a App Template resource.", "description": "Available since: 6.3.1.0", "operationId": "deleteAppTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "App Template" ], "summary": "Partially update information about a App Template resource.", "description": "Available since: 6.3.1.0", "operationId": "updateAppTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a App Template resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/app-template": { "post": { "tags": [ "App Template" ], "summary": "Aggregate for the App Template resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of AppTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/category": { "get": { "tags": [ "Category" ], "summary": "List with basic information of Category resources.", "description": "Available since: 6.0.0.0", "operationId": "getCategoryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Category resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/category?limit=25" }, "last": { "example": "/category?limit=25&page=11" }, "next": { "example": "/category?limit=25&page=4" }, "prev": { "example": "/category?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Category" ], "summary": "Create a new Category resources.", "description": "Available since: 6.0.0.0", "operationId": "createCategory", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Category" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Category" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/category": { "post": { "tags": [ "Category" ], "summary": "Search for the Category resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCategory", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Category", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/category/{id}": { "get": { "tags": [ "Category" ], "summary": "Detailed information about a Category resource.", "description": "Available since: 6.0.0.0", "operationId": "getCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Category" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Category" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Category" ], "summary": "Delete a Category resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Category" ], "summary": "Partially update information about a Category resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Category resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Category" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Category" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/category": { "post": { "tags": [ "Category" ], "summary": "Aggregate for the Category resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCategory", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Category", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-block": { "get": { "tags": [ "Cms Block" ], "summary": "List with basic information of Cms Block resources.", "description": "Available since: 6.0.0.0", "operationId": "getCmsBlockList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Cms Block resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-block?limit=25" }, "last": { "example": "/cms-block?limit=25&page=11" }, "next": { "example": "/cms-block?limit=25&page=4" }, "prev": { "example": "/cms-block?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Cms Block" ], "summary": "Create a new Cms Block resources.", "description": "Available since: 6.0.0.0", "operationId": "createCmsBlock", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-block": { "post": { "tags": [ "Cms Block" ], "summary": "Search for the Cms Block resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsBlock", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-block/{id}": { "get": { "tags": [ "Cms Block" ], "summary": "Detailed information about a Cms Block resource.", "description": "Available since: 6.0.0.0", "operationId": "getCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Cms Block" ], "summary": "Delete a Cms Block resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Cms Block" ], "summary": "Partially update information about a Cms Block resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCmsBlock", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Cms Block resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsBlock" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/cms-block": { "post": { "tags": [ "Cms Block" ], "summary": "Aggregate for the Cms Block resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsBlock", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CmsBlock", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-page": { "get": { "tags": [ "Cms Page" ], "summary": "List with basic information of Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "getCmsPageList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-page?limit=25" }, "last": { "example": "/cms-page?limit=25&page=11" }, "next": { "example": "/cms-page?limit=25&page=4" }, "prev": { "example": "/cms-page?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Cms Page" ], "summary": "Create a new Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "createCmsPage", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-page": { "post": { "tags": [ "Cms Page" ], "summary": "Search for the Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsPage", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-page/{id}": { "get": { "tags": [ "Cms Page" ], "summary": "Detailed information about a Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "getCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Cms Page" ], "summary": "Delete a Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Cms Page" ], "summary": "Partially update information about a Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Cms Page resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/cms-page": { "post": { "tags": [ "Cms Page" ], "summary": "Aggregate for the Cms Page resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsPage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-section": { "get": { "tags": [ "Cms Section" ], "summary": "List with basic information of Cms Section resources.", "description": "Available since: 6.0.0.0", "operationId": "getCmsSectionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Cms Section resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-section?limit=25" }, "last": { "example": "/cms-section?limit=25&page=11" }, "next": { "example": "/cms-section?limit=25&page=4" }, "prev": { "example": "/cms-section?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Cms Section" ], "summary": "Create a new Cms Section resources.", "description": "Available since: 6.0.0.0", "operationId": "createCmsSection", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-section": { "post": { "tags": [ "Cms Section" ], "summary": "Search for the Cms Section resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsSection", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CmsSection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-section/{id}": { "get": { "tags": [ "Cms Section" ], "summary": "Detailed information about a Cms Section resource.", "description": "Available since: 6.0.0.0", "operationId": "getCmsSection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Cms Section" ], "summary": "Delete a Cms Section resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCmsSection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Cms Section" ], "summary": "Partially update information about a Cms Section resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCmsSection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Cms Section resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/cms-section": { "post": { "tags": [ "Cms Section" ], "summary": "Aggregate for the Cms Section resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsSection", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CmsSection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-slot": { "get": { "tags": [ "Cms Slot" ], "summary": "List with basic information of Cms Slot resources.", "description": "Available since: 6.0.0.0", "operationId": "getCmsSlotList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Cms Slot resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-slot?limit=25" }, "last": { "example": "/cms-slot?limit=25&page=11" }, "next": { "example": "/cms-slot?limit=25&page=4" }, "prev": { "example": "/cms-slot?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Cms Slot" ], "summary": "Create a new Cms Slot resources.", "description": "Available since: 6.0.0.0", "operationId": "createCmsSlot", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-slot": { "post": { "tags": [ "Cms Slot" ], "summary": "Search for the Cms Slot resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsSlot", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CmsSlot", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-slot/{id}": { "get": { "tags": [ "Cms Slot" ], "summary": "Detailed information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", "operationId": "getCmsSlot", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Cms Slot" ], "summary": "Delete a Cms Slot resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCmsSlot", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Cms Slot" ], "summary": "Partially update information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCmsSlot", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Cms Slot resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CmsSlot" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/cms-slot": { "post": { "tags": [ "Cms Slot" ], "summary": "Aggregate for the Cms Slot resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsSlot", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CmsSlot", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/country": { "get": { "tags": [ "Country" ], "summary": "List with basic information of Country resources.", "description": "Available since: 6.0.0.0", "operationId": "getCountryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Country resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/country?limit=25" }, "last": { "example": "/country?limit=25&page=11" }, "next": { "example": "/country?limit=25&page=4" }, "prev": { "example": "/country?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Country" ], "summary": "Create a new Country resources.", "description": "Available since: 6.0.0.0", "operationId": "createCountry", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Country" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Country" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/country": { "post": { "tags": [ "Country" ], "summary": "Search for the Country resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCountry", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Country", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/country/{id}": { "get": { "tags": [ "Country" ], "summary": "Detailed information about a Country resource.", "description": "Available since: 6.0.0.0", "operationId": "getCountry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Country" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Country" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Country" ], "summary": "Delete a Country resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCountry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Country" ], "summary": "Partially update information about a Country resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCountry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Country resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Country" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Country" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/country": { "post": { "tags": [ "Country" ], "summary": "Aggregate for the Country resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCountry", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Country", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/country-state": { "get": { "tags": [ "Country State" ], "summary": "List with basic information of Country State resources.", "description": "Available since: 6.0.0.0", "operationId": "getCountryStateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Country State resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/country-state?limit=25" }, "last": { "example": "/country-state?limit=25&page=11" }, "next": { "example": "/country-state?limit=25&page=4" }, "prev": { "example": "/country-state?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Country State" ], "summary": "Create a new Country State resources.", "description": "Available since: 6.0.0.0", "operationId": "createCountryState", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/country-state": { "post": { "tags": [ "Country State" ], "summary": "Search for the Country State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCountryState", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CountryState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/country-state/{id}": { "get": { "tags": [ "Country State" ], "summary": "Detailed information about a Country State resource.", "description": "Available since: 6.0.0.0", "operationId": "getCountryState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Country State" ], "summary": "Delete a Country State resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCountryState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Country State" ], "summary": "Partially update information about a Country State resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCountryState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Country State resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CountryState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/country-state": { "post": { "tags": [ "Country State" ], "summary": "Aggregate for the Country State resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCountryState", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CountryState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/currency": { "get": { "tags": [ "Currency" ], "summary": "List with basic information of Currency resources.", "description": "Available since: 6.0.0.0", "operationId": "getCurrencyList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Currency resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/currency?limit=25" }, "last": { "example": "/currency?limit=25&page=11" }, "next": { "example": "/currency?limit=25&page=4" }, "prev": { "example": "/currency?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Currency" ], "summary": "Create a new Currency resources.", "description": "Available since: 6.0.0.0", "operationId": "createCurrency", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/currency": { "post": { "tags": [ "Currency" ], "summary": "Search for the Currency resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCurrency", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Currency", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/currency/{id}": { "get": { "tags": [ "Currency" ], "summary": "Detailed information about a Currency resource.", "description": "Available since: 6.0.0.0", "operationId": "getCurrency", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Currency" ], "summary": "Delete a Currency resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCurrency", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Currency" ], "summary": "Partially update information about a Currency resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCurrency", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Currency resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Currency" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/currency": { "post": { "tags": [ "Currency" ], "summary": "Aggregate for the Currency resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCurrency", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Currency", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/currency-country-rounding": { "get": { "tags": [ "Currency Country Rounding" ], "summary": "List with basic information of Currency Country Rounding resources.", "description": "Available since: 6.4.0.0", "operationId": "getCurrencyCountryRoundingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Currency Country Rounding resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/currency-country-rounding?limit=25" }, "last": { "example": "/currency-country-rounding?limit=25&page=11" }, "next": { "example": "/currency-country-rounding?limit=25&page=4" }, "prev": { "example": "/currency-country-rounding?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Currency Country Rounding" ], "summary": "Create a new Currency Country Rounding resources.", "description": "Available since: 6.4.0.0", "operationId": "createCurrencyCountryRounding", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/currency-country-rounding": { "post": { "tags": [ "Currency Country Rounding" ], "summary": "Search for the Currency Country Rounding resources.", "description": "Available since: 6.4.0.0", "operationId": "searchCurrencyCountryRounding", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/currency-country-rounding/{id}": { "get": { "tags": [ "Currency Country Rounding" ], "summary": "Detailed information about a Currency Country Rounding resource.", "description": "Available since: 6.4.0.0", "operationId": "getCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Currency Country Rounding" ], "summary": "Delete a Currency Country Rounding resource.", "description": "Available since: 6.4.0.0", "operationId": "deleteCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Currency Country Rounding" ], "summary": "Partially update information about a Currency Country Rounding resource.", "description": "Available since: 6.4.0.0", "operationId": "updateCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Currency Country Rounding resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/currency-country-rounding": { "post": { "tags": [ "Currency Country Rounding" ], "summary": "Aggregate for the Currency Country Rounding resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCurrencyCountryRounding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-entity": { "get": { "tags": [ "Custom Entity" ], "summary": "List with basic information of Custom Entity resources.", "description": "Available since: 6.4.9.0", "operationId": "getCustomEntityList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Custom Entity resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/custom-entity?limit=25" }, "last": { "example": "/custom-entity?limit=25&page=11" }, "next": { "example": "/custom-entity?limit=25&page=4" }, "prev": { "example": "/custom-entity?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Custom Entity" ], "summary": "Create a new Custom Entity resources.", "description": "Available since: 6.4.9.0", "operationId": "createCustomEntity", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/custom-entity": { "post": { "tags": [ "Custom Entity" ], "summary": "Search for the Custom Entity resources.", "description": "Available since: 6.4.9.0", "operationId": "searchCustomEntity", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomEntity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-entity/{id}": { "get": { "tags": [ "Custom Entity" ], "summary": "Detailed information about a Custom Entity resource.", "description": "Available since: 6.4.9.0", "operationId": "getCustomEntity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Custom Entity" ], "summary": "Delete a Custom Entity resource.", "description": "Available since: 6.4.9.0", "operationId": "deleteCustomEntity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Custom Entity" ], "summary": "Partially update information about a Custom Entity resource.", "description": "Available since: 6.4.9.0", "operationId": "updateCustomEntity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Custom Entity resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomEntity" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/custom-entity": { "post": { "tags": [ "Custom Entity" ], "summary": "Aggregate for the Custom Entity resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomEntity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomEntity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEntity" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field": { "get": { "tags": [ "Custom Field" ], "summary": "List with basic information of Custom Field resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomFieldList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Custom Field resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/custom-field?limit=25" }, "last": { "example": "/custom-field?limit=25&page=11" }, "next": { "example": "/custom-field?limit=25&page=4" }, "prev": { "example": "/custom-field?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Custom Field" ], "summary": "Create a new Custom Field resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomField", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/custom-field": { "post": { "tags": [ "Custom Field" ], "summary": "Search for the Custom Field resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomField", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field/{id}": { "get": { "tags": [ "Custom Field" ], "summary": "Detailed information about a Custom Field resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Custom Field" ], "summary": "Delete a Custom Field resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Custom Field" ], "summary": "Partially update information about a Custom Field resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Custom Field resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/custom-field": { "post": { "tags": [ "Custom Field" ], "summary": "Aggregate for the Custom Field resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomField", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field-set": { "get": { "tags": [ "Custom Field Set" ], "summary": "List with basic information of Custom Field Set resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomFieldSetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Custom Field Set resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/custom-field-set?limit=25" }, "last": { "example": "/custom-field-set?limit=25&page=11" }, "next": { "example": "/custom-field-set?limit=25&page=4" }, "prev": { "example": "/custom-field-set?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Custom Field Set" ], "summary": "Create a new Custom Field Set resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomFieldSet", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/custom-field-set": { "post": { "tags": [ "Custom Field Set" ], "summary": "Search for the Custom Field Set resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomFieldSet", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field-set/{id}": { "get": { "tags": [ "Custom Field Set" ], "summary": "Detailed information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomFieldSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Custom Field Set" ], "summary": "Delete a Custom Field Set resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomFieldSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Custom Field Set" ], "summary": "Partially update information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomFieldSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Custom Field Set resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/custom-field-set": { "post": { "tags": [ "Custom Field Set" ], "summary": "Aggregate for the Custom Field Set resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomFieldSet", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field-set-relation": { "get": { "tags": [ "Custom Field Set Relation" ], "summary": "List with basic information of Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomFieldSetRelationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Custom Field Set Relation resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/custom-field-set-relation?limit=25" }, "last": { "example": "/custom-field-set-relation?limit=25&page=11" }, "next": { "example": "/custom-field-set-relation?limit=25&page=4" }, "prev": { "example": "/custom-field-set-relation?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Custom Field Set Relation" ], "summary": "Create a new Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomFieldSetRelation", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/custom-field-set-relation": { "post": { "tags": [ "Custom Field Set Relation" ], "summary": "Search for the Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomFieldSetRelation", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-field-set-relation/{id}": { "get": { "tags": [ "Custom Field Set Relation" ], "summary": "Detailed information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Custom Field Set Relation" ], "summary": "Delete a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Custom Field Set Relation" ], "summary": "Partially update information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Custom Field Set Relation resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/custom-field-set-relation": { "post": { "tags": [ "Custom Field Set Relation" ], "summary": "Aggregate for the Custom Field Set Relation resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomFieldSetRelation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer": { "get": { "tags": [ "Customer" ], "summary": "List with basic information of Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer?limit=25" }, "last": { "example": "/customer?limit=25&page=11" }, "next": { "example": "/customer?limit=25&page=4" }, "prev": { "example": "/customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer" ], "summary": "Create a new Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer": { "post": { "tags": [ "Customer" ], "summary": "Search for the Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Customer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer/{id}": { "get": { "tags": [ "Customer" ], "summary": "Detailed information about a Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer" ], "summary": "Delete a Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer" ], "summary": "Partially update information about a Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Customer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer": { "post": { "tags": [ "Customer" ], "summary": "Aggregate for the Customer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Customer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-address": { "get": { "tags": [ "Customer Address" ], "summary": "List with basic information of Customer Address resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomerAddressList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Address resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-address?limit=25" }, "last": { "example": "/customer-address?limit=25&page=11" }, "next": { "example": "/customer-address?limit=25&page=4" }, "prev": { "example": "/customer-address?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer Address" ], "summary": "Create a new Customer Address resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomerAddress", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-address": { "post": { "tags": [ "Customer Address" ], "summary": "Search for the Customer Address resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomerAddress", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-address/{id}": { "get": { "tags": [ "Customer Address" ], "summary": "Detailed information about a Customer Address resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer Address" ], "summary": "Delete a Customer Address resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer Address" ], "summary": "Partially update information about a Customer Address resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Address resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer-address": { "post": { "tags": [ "Customer Address" ], "summary": "Aggregate for the Customer Address resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerAddress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-group": { "get": { "tags": [ "Customer Group" ], "summary": "List with basic information of Customer Group resources.", "description": "Available since: 6.0.0.0", "operationId": "getCustomerGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Group resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-group?limit=25" }, "last": { "example": "/customer-group?limit=25&page=11" }, "next": { "example": "/customer-group?limit=25&page=4" }, "prev": { "example": "/customer-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer Group" ], "summary": "Create a new Customer Group resources.", "description": "Available since: 6.0.0.0", "operationId": "createCustomerGroup", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-group": { "post": { "tags": [ "Customer Group" ], "summary": "Search for the Customer Group resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomerGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-group/{id}": { "get": { "tags": [ "Customer Group" ], "summary": "Detailed information about a Customer Group resource.", "description": "Available since: 6.0.0.0", "operationId": "getCustomerGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer Group" ], "summary": "Delete a Customer Group resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteCustomerGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer Group" ], "summary": "Partially update information about a Customer Group resource.", "description": "Available since: 6.0.0.0", "operationId": "updateCustomerGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer-group": { "post": { "tags": [ "Customer Group" ], "summary": "Aggregate for the Customer Group resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-recovery": { "get": { "tags": [ "Customer Recovery" ], "summary": "List with basic information of Customer Recovery resources.", "description": "Available since: 6.1.0.0", "operationId": "getCustomerRecoveryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Recovery resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-recovery?limit=25" }, "last": { "example": "/customer-recovery?limit=25&page=11" }, "next": { "example": "/customer-recovery?limit=25&page=4" }, "prev": { "example": "/customer-recovery?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer Recovery" ], "summary": "Create a new Customer Recovery resources.", "description": "Available since: 6.1.0.0", "operationId": "createCustomerRecovery", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-recovery": { "post": { "tags": [ "Customer Recovery" ], "summary": "Search for the Customer Recovery resources.", "description": "Available since: 6.1.0.0", "operationId": "searchCustomerRecovery", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-recovery/{id}": { "get": { "tags": [ "Customer Recovery" ], "summary": "Detailed information about a Customer Recovery resource.", "description": "Available since: 6.1.0.0", "operationId": "getCustomerRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer Recovery" ], "summary": "Delete a Customer Recovery resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteCustomerRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer Recovery" ], "summary": "Partially update information about a Customer Recovery resource.", "description": "Available since: 6.1.0.0", "operationId": "updateCustomerRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Recovery resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer-recovery": { "post": { "tags": [ "Customer Recovery" ], "summary": "Aggregate for the Customer Recovery resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerRecovery", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRecovery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-wishlist": { "get": { "tags": [ "Customer Wishlist" ], "summary": "List with basic information of Customer Wishlist resources.", "description": "Available since: 6.3.4.0", "operationId": "getCustomerWishlistList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Wishlist resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-wishlist?limit=25" }, "last": { "example": "/customer-wishlist?limit=25&page=11" }, "next": { "example": "/customer-wishlist?limit=25&page=4" }, "prev": { "example": "/customer-wishlist?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer Wishlist" ], "summary": "Create a new Customer Wishlist resources.", "description": "Available since: 6.3.4.0", "operationId": "createCustomerWishlist", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-wishlist": { "post": { "tags": [ "Customer Wishlist" ], "summary": "Search for the Customer Wishlist resources.", "description": "Available since: 6.3.4.0", "operationId": "searchCustomerWishlist", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-wishlist/{id}": { "get": { "tags": [ "Customer Wishlist" ], "summary": "Detailed information about a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", "operationId": "getCustomerWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer Wishlist" ], "summary": "Delete a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", "operationId": "deleteCustomerWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer Wishlist" ], "summary": "Partially update information about a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", "operationId": "updateCustomerWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Wishlist resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer-wishlist": { "post": { "tags": [ "Customer Wishlist" ], "summary": "Aggregate for the Customer Wishlist resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerWishlist", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-wishlist-product": { "get": { "tags": [ "Customer Wishlist Product" ], "summary": "List with basic information of Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", "operationId": "getCustomerWishlistProductList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Wishlist Product resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-wishlist-product?limit=25" }, "last": { "example": "/customer-wishlist-product?limit=25&page=11" }, "next": { "example": "/customer-wishlist-product?limit=25&page=4" }, "prev": { "example": "/customer-wishlist-product?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Customer Wishlist Product" ], "summary": "Create a new Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", "operationId": "createCustomerWishlistProduct", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-wishlist-product": { "post": { "tags": [ "Customer Wishlist Product" ], "summary": "Search for the Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", "operationId": "searchCustomerWishlistProduct", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-wishlist-product/{id}": { "get": { "tags": [ "Customer Wishlist Product" ], "summary": "Detailed information about a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", "operationId": "getCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Customer Wishlist Product" ], "summary": "Delete a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", "operationId": "deleteCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Customer Wishlist Product" ], "summary": "Partially update information about a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", "operationId": "updateCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Wishlist Product resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/customer-wishlist-product": { "post": { "tags": [ "Customer Wishlist Product" ], "summary": "Aggregate for the Customer Wishlist Product resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerWishlistProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/delivery-time": { "get": { "tags": [ "Delivery Time" ], "summary": "List with basic information of Delivery Time resources.", "description": "Available since: 6.0.0.0", "operationId": "getDeliveryTimeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Delivery Time resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/delivery-time?limit=25" }, "last": { "example": "/delivery-time?limit=25&page=11" }, "next": { "example": "/delivery-time?limit=25&page=4" }, "prev": { "example": "/delivery-time?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Delivery Time" ], "summary": "Create a new Delivery Time resources.", "description": "Available since: 6.0.0.0", "operationId": "createDeliveryTime", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/delivery-time": { "post": { "tags": [ "Delivery Time" ], "summary": "Search for the Delivery Time resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDeliveryTime", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/delivery-time/{id}": { "get": { "tags": [ "Delivery Time" ], "summary": "Detailed information about a Delivery Time resource.", "description": "Available since: 6.0.0.0", "operationId": "getDeliveryTime", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Delivery Time" ], "summary": "Delete a Delivery Time resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDeliveryTime", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Delivery Time" ], "summary": "Partially update information about a Delivery Time resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDeliveryTime", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Delivery Time resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DeliveryTime" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/delivery-time": { "post": { "tags": [ "Delivery Time" ], "summary": "Aggregate for the Delivery Time resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDeliveryTime", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTime" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document": { "get": { "tags": [ "Document" ], "summary": "List with basic information of Document resources.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Document resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/document?limit=25" }, "last": { "example": "/document?limit=25&page=11" }, "next": { "example": "/document?limit=25&page=4" }, "prev": { "example": "/document?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Document" ], "summary": "Create a new Document resources.", "description": "Available since: 6.0.0.0", "operationId": "createDocument", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Document" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/document": { "post": { "tags": [ "Document" ], "summary": "Search for the Document resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocument", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Document", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document/{id}": { "get": { "tags": [ "Document" ], "summary": "Detailed information about a Document resource.", "description": "Available since: 6.0.0.0", "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Document" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Document" ], "summary": "Delete a Document resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Document" ], "summary": "Partially update information about a Document resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Document resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Document" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/document": { "post": { "tags": [ "Document" ], "summary": "Aggregate for the Document resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDocument", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Document", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-base-config": { "get": { "tags": [ "Document Base Config" ], "summary": "List with basic information of Document Base Config resources.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentBaseConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Document Base Config resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/document-base-config?limit=25" }, "last": { "example": "/document-base-config?limit=25&page=11" }, "next": { "example": "/document-base-config?limit=25&page=4" }, "prev": { "example": "/document-base-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Document Base Config" ], "summary": "Create a new Document Base Config resources.", "description": "Available since: 6.0.0.0", "operationId": "createDocumentBaseConfig", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/document-base-config": { "post": { "tags": [ "Document Base Config" ], "summary": "Search for the Document Base Config resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentBaseConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-base-config/{id}": { "get": { "tags": [ "Document Base Config" ], "summary": "Detailed information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Document Base Config" ], "summary": "Delete a Document Base Config resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Document Base Config" ], "summary": "Partially update information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Document Base Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/document-base-config": { "post": { "tags": [ "Document Base Config" ], "summary": "Aggregate for the Document Base Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDocumentBaseConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-base-config-sales-channel": { "get": { "tags": [ "Document Base Config Sales Channel" ], "summary": "List with basic information of Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentBaseConfigSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Document Base Config Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/document-base-config-sales-channel?limit=25" }, "last": { "example": "/document-base-config-sales-channel?limit=25&page=11" }, "next": { "example": "/document-base-config-sales-channel?limit=25&page=4" }, "prev": { "example": "/document-base-config-sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Create a new Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "createDocumentBaseConfigSalesChannel", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/document-base-config-sales-channel": { "post": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Search for the Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentBaseConfigSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-base-config-sales-channel/{id}": { "get": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Detailed information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Delete a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Partially update information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Document Base Config Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/document-base-config-sales-channel": { "post": { "tags": [ "Document Base Config Sales Channel" ], "summary": "Aggregate for the Document Base Config Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDocumentBaseConfigSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-file": { "get": { "tags": [ "Document File" ], "summary": "List with basic information of Document File resources.", "description": "Available since: 6.7.10.0", "operationId": "getDocumentFileList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Document File resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/document-file?limit=25" }, "last": { "example": "/document-file?limit=25&page=11" }, "next": { "example": "/document-file?limit=25&page=4" }, "prev": { "example": "/document-file?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Document File" ], "summary": "Create a new Document File resources.", "description": "Available since: 6.7.10.0", "operationId": "createDocumentFile", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/document-file": { "post": { "tags": [ "Document File" ], "summary": "Search for the Document File resources.", "description": "Available since: 6.7.10.0", "operationId": "searchDocumentFile", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-file/{id}": { "get": { "tags": [ "Document File" ], "summary": "Detailed information about a Document File resource.", "description": "Available since: 6.7.10.0", "operationId": "getDocumentFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Document File" ], "summary": "Delete a Document File resource.", "description": "Available since: 6.7.10.0", "operationId": "deleteDocumentFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Document File" ], "summary": "Partially update information about a Document File resource.", "description": "Available since: 6.7.10.0", "operationId": "updateDocumentFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Document File resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/document-file": { "post": { "tags": [ "Document File" ], "summary": "Aggregate for the Document File resources.", "description": "Available since: 6.7.10.0", "operationId": "aggregateDocumentFile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-type": { "get": { "tags": [ "Document Type" ], "summary": "List with basic information of Document Type resources.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentTypeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Document Type resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/document-type?limit=25" }, "last": { "example": "/document-type?limit=25&page=11" }, "next": { "example": "/document-type?limit=25&page=4" }, "prev": { "example": "/document-type?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Document Type" ], "summary": "Create a new Document Type resources.", "description": "Available since: 6.0.0.0", "operationId": "createDocumentType", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/document-type": { "post": { "tags": [ "Document Type" ], "summary": "Search for the Document Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentType", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of DocumentType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-type/{id}": { "get": { "tags": [ "Document Type" ], "summary": "Detailed information about a Document Type resource.", "description": "Available since: 6.0.0.0", "operationId": "getDocumentType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Document Type" ], "summary": "Delete a Document Type resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDocumentType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Document Type" ], "summary": "Partially update information about a Document Type resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDocumentType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Document Type resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DocumentType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/document-type": { "post": { "tags": [ "Document Type" ], "summary": "Aggregate for the Document Type resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDocumentType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of DocumentType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow": { "get": { "tags": [ "Flow" ], "summary": "List with basic information of Flow resources.", "description": "Available since: 6.4.6.0", "operationId": "getFlowList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Flow resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/flow?limit=25" }, "last": { "example": "/flow?limit=25&page=11" }, "next": { "example": "/flow?limit=25&page=4" }, "prev": { "example": "/flow?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Flow" ], "summary": "Create a new Flow resources.", "description": "Available since: 6.4.6.0", "operationId": "createFlow", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/flow": { "post": { "tags": [ "Flow" ], "summary": "Search for the Flow resources.", "description": "Available since: 6.4.6.0", "operationId": "searchFlow", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Flow", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow/{id}": { "get": { "tags": [ "Flow" ], "summary": "Detailed information about a Flow resource.", "description": "Available since: 6.4.6.0", "operationId": "getFlow", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Flow" ], "summary": "Delete a Flow resource.", "description": "Available since: 6.4.6.0", "operationId": "deleteFlow", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Flow" ], "summary": "Partially update information about a Flow resource.", "description": "Available since: 6.4.6.0", "operationId": "updateFlow", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Flow resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Flow" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/flow": { "post": { "tags": [ "Flow" ], "summary": "Aggregate for the Flow resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateFlow", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Flow", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow-sequence": { "get": { "tags": [ "Flow Sequence" ], "summary": "List with basic information of Flow Sequence resources.", "description": "Available since: 6.4.6.0", "operationId": "getFlowSequenceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Flow Sequence resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/flow-sequence?limit=25" }, "last": { "example": "/flow-sequence?limit=25&page=11" }, "next": { "example": "/flow-sequence?limit=25&page=4" }, "prev": { "example": "/flow-sequence?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Flow Sequence" ], "summary": "Create a new Flow Sequence resources.", "description": "Available since: 6.4.6.0", "operationId": "createFlowSequence", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/flow-sequence": { "post": { "tags": [ "Flow Sequence" ], "summary": "Search for the Flow Sequence resources.", "description": "Available since: 6.4.6.0", "operationId": "searchFlowSequence", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of FlowSequence", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow-sequence/{id}": { "get": { "tags": [ "Flow Sequence" ], "summary": "Detailed information about a Flow Sequence resource.", "description": "Available since: 6.4.6.0", "operationId": "getFlowSequence", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Flow Sequence" ], "summary": "Delete a Flow Sequence resource.", "description": "Available since: 6.4.6.0", "operationId": "deleteFlowSequence", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Flow Sequence" ], "summary": "Partially update information about a Flow Sequence resource.", "description": "Available since: 6.4.6.0", "operationId": "updateFlowSequence", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Flow Sequence resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowSequence" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/flow-sequence": { "post": { "tags": [ "Flow Sequence" ], "summary": "Aggregate for the Flow Sequence resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateFlowSequence", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of FlowSequence", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow-template": { "get": { "tags": [ "Flow Template" ], "summary": "List with basic information of Flow Template resources.", "description": "Available since: 6.4.18.0", "operationId": "getFlowTemplateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Flow Template resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/flow-template?limit=25" }, "last": { "example": "/flow-template?limit=25&page=11" }, "next": { "example": "/flow-template?limit=25&page=4" }, "prev": { "example": "/flow-template?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Flow Template" ], "summary": "Create a new Flow Template resources.", "description": "Available since: 6.4.18.0", "operationId": "createFlowTemplate", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/flow-template": { "post": { "tags": [ "Flow Template" ], "summary": "Search for the Flow Template resources.", "description": "Available since: 6.4.18.0", "operationId": "searchFlowTemplate", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/flow-template/{id}": { "get": { "tags": [ "Flow Template" ], "summary": "Detailed information about a Flow Template resource.", "description": "Available since: 6.4.18.0", "operationId": "getFlowTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Flow Template" ], "summary": "Delete a Flow Template resource.", "description": "Available since: 6.4.18.0", "operationId": "deleteFlowTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Flow Template" ], "summary": "Partially update information about a Flow Template resource.", "description": "Available since: 6.4.18.0", "operationId": "updateFlowTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Flow Template resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/FlowTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/flow-template": { "post": { "tags": [ "Flow Template" ], "summary": "Aggregate for the Flow Template resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateFlowTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-file": { "get": { "tags": [ "Import Export File" ], "summary": "List with basic information of Import Export File resources.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportFileList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Import Export File resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/import-export-file?limit=25" }, "last": { "example": "/import-export-file?limit=25&page=11" }, "next": { "example": "/import-export-file?limit=25&page=4" }, "prev": { "example": "/import-export-file?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Import Export File" ], "summary": "Create a new Import Export File resources.", "description": "Available since: 6.0.0.0", "operationId": "createImportExportFile", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/import-export-file": { "post": { "tags": [ "Import Export File" ], "summary": "Search for the Import Export File resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportFile", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-file/{id}": { "get": { "tags": [ "Import Export File" ], "summary": "Detailed information about a Import Export File resource.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Import Export File" ], "summary": "Delete a Import Export File resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteImportExportFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Import Export File" ], "summary": "Partially update information about a Import Export File resource.", "description": "Available since: 6.0.0.0", "operationId": "updateImportExportFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Import Export File resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/import-export-file": { "post": { "tags": [ "Import Export File" ], "summary": "Aggregate for the Import Export File resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateImportExportFile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-log": { "get": { "tags": [ "Import Export Log" ], "summary": "List with basic information of Import Export Log resources.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportLogList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Import Export Log resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/import-export-log?limit=25" }, "last": { "example": "/import-export-log?limit=25&page=11" }, "next": { "example": "/import-export-log?limit=25&page=4" }, "prev": { "example": "/import-export-log?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Import Export Log" ], "summary": "Create a new Import Export Log resources.", "description": "Available since: 6.0.0.0", "operationId": "createImportExportLog", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/import-export-log": { "post": { "tags": [ "Import Export Log" ], "summary": "Search for the Import Export Log resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportLog", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-log/{id}": { "get": { "tags": [ "Import Export Log" ], "summary": "Detailed information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Import Export Log" ], "summary": "Delete a Import Export Log resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteImportExportLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Import Export Log" ], "summary": "Partially update information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", "operationId": "updateImportExportLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Import Export Log resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/import-export-log": { "post": { "tags": [ "Import Export Log" ], "summary": "Aggregate for the Import Export Log resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateImportExportLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-profile": { "get": { "tags": [ "Import Export Profile" ], "summary": "List with basic information of Import Export Profile resources.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportProfileList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Import Export Profile resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/import-export-profile?limit=25" }, "last": { "example": "/import-export-profile?limit=25&page=11" }, "next": { "example": "/import-export-profile?limit=25&page=4" }, "prev": { "example": "/import-export-profile?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Import Export Profile" ], "summary": "Create a new Import Export Profile resources.", "description": "Available since: 6.0.0.0", "operationId": "createImportExportProfile", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/import-export-profile": { "post": { "tags": [ "Import Export Profile" ], "summary": "Search for the Import Export Profile resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportProfile", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/import-export-profile/{id}": { "get": { "tags": [ "Import Export Profile" ], "summary": "Detailed information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", "operationId": "getImportExportProfile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Import Export Profile" ], "summary": "Delete a Import Export Profile resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteImportExportProfile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Import Export Profile" ], "summary": "Partially update information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", "operationId": "updateImportExportProfile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Import Export Profile resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/import-export-profile": { "post": { "tags": [ "Import Export Profile" ], "summary": "Aggregate for the Import Export Profile resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateImportExportProfile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportProfile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/integration": { "get": { "tags": [ "Integration" ], "summary": "List with basic information of Integration resources.", "description": "Available since: 6.0.0.0", "operationId": "getIntegrationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Integration resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/integration?limit=25" }, "last": { "example": "/integration?limit=25&page=11" }, "next": { "example": "/integration?limit=25&page=4" }, "prev": { "example": "/integration?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Integration" ], "summary": "Create a new Integration resources.", "description": "Available since: 6.0.0.0", "operationId": "createIntegration", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/integration": { "post": { "tags": [ "Integration" ], "summary": "Search for the Integration resources.", "description": "Available since: 6.0.0.0", "operationId": "searchIntegration", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Integration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/integration/{id}": { "get": { "tags": [ "Integration" ], "summary": "Detailed information about a Integration resource.", "description": "Available since: 6.0.0.0", "operationId": "getIntegration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the integration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Integration" ], "summary": "Delete a Integration resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteIntegration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the integration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Integration" ], "summary": "Partially update information about a Integration resource.", "description": "Available since: 6.0.0.0", "operationId": "updateIntegration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the integration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Integration resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Integration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/integration": { "post": { "tags": [ "Integration" ], "summary": "Aggregate for the Integration resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateIntegration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Integration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/landing-page": { "get": { "tags": [ "Landing Page" ], "summary": "List with basic information of Landing Page resources.", "description": "Available since: 6.4.0.0", "operationId": "getLandingPageList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Landing Page resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/landing-page?limit=25" }, "last": { "example": "/landing-page?limit=25&page=11" }, "next": { "example": "/landing-page?limit=25&page=4" }, "prev": { "example": "/landing-page?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Landing Page" ], "summary": "Create a new Landing Page resources.", "description": "Available since: 6.4.0.0", "operationId": "createLandingPage", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/landing-page": { "post": { "tags": [ "Landing Page" ], "summary": "Search for the Landing Page resources.", "description": "Available since: 6.4.0.0", "operationId": "searchLandingPage", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of LandingPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/landing-page/{id}": { "get": { "tags": [ "Landing Page" ], "summary": "Detailed information about a Landing Page resource.", "description": "Available since: 6.4.0.0", "operationId": "getLandingPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Landing Page" ], "summary": "Delete a Landing Page resource.", "description": "Available since: 6.4.0.0", "operationId": "deleteLandingPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Landing Page" ], "summary": "Partially update information about a Landing Page resource.", "description": "Available since: 6.4.0.0", "operationId": "updateLandingPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Landing Page resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LandingPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/landing-page": { "post": { "tags": [ "Landing Page" ], "summary": "Aggregate for the Landing Page resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateLandingPage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of LandingPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/language": { "get": { "tags": [ "Language" ], "summary": "List with basic information of Language resources.", "description": "Available since: 6.0.0.0", "operationId": "getLanguageList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Language resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/language?limit=25" }, "last": { "example": "/language?limit=25&page=11" }, "next": { "example": "/language?limit=25&page=4" }, "prev": { "example": "/language?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Language" ], "summary": "Create a new Language resources.", "description": "Available since: 6.0.0.0", "operationId": "createLanguage", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Language" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Language" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/language": { "post": { "tags": [ "Language" ], "summary": "Search for the Language resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLanguage", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Language", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/language/{id}": { "get": { "tags": [ "Language" ], "summary": "Detailed information about a Language resource.", "description": "Available since: 6.0.0.0", "operationId": "getLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the language", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Language" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Language" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Language" ], "summary": "Delete a Language resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the language", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Language" ], "summary": "Partially update information about a Language resource.", "description": "Available since: 6.0.0.0", "operationId": "updateLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the language", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Language resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Language" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Language" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/language": { "post": { "tags": [ "Language" ], "summary": "Aggregate for the Language resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateLanguage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Language", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/locale": { "get": { "tags": [ "Locale" ], "summary": "List with basic information of Locale resources.", "description": "Available since: 6.0.0.0", "operationId": "getLocaleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Locale resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/locale?limit=25" }, "last": { "example": "/locale?limit=25&page=11" }, "next": { "example": "/locale?limit=25&page=4" }, "prev": { "example": "/locale?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Locale" ], "summary": "Create a new Locale resources.", "description": "Available since: 6.0.0.0", "operationId": "createLocale", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/locale": { "post": { "tags": [ "Locale" ], "summary": "Search for the Locale resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLocale", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Locale", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/locale/{id}": { "get": { "tags": [ "Locale" ], "summary": "Detailed information about a Locale resource.", "description": "Available since: 6.0.0.0", "operationId": "getLocale", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the locale", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Locale" ], "summary": "Delete a Locale resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteLocale", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the locale", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Locale" ], "summary": "Partially update information about a Locale resource.", "description": "Available since: 6.0.0.0", "operationId": "updateLocale", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the locale", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Locale resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Locale" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/locale": { "post": { "tags": [ "Locale" ], "summary": "Aggregate for the Locale resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateLocale", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Locale", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/log-entry": { "get": { "tags": [ "Log Entry" ], "summary": "List with basic information of Log Entry resources.", "description": "Available since: 6.0.0.0", "operationId": "getLogEntryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Log Entry resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/log-entry?limit=25" }, "last": { "example": "/log-entry?limit=25&page=11" }, "next": { "example": "/log-entry?limit=25&page=4" }, "prev": { "example": "/log-entry?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Log Entry" ], "summary": "Create a new Log Entry resources.", "description": "Available since: 6.0.0.0", "operationId": "createLogEntry", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/log-entry": { "post": { "tags": [ "Log Entry" ], "summary": "Search for the Log Entry resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLogEntry", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of LogEntry", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/log-entry/{id}": { "get": { "tags": [ "Log Entry" ], "summary": "Detailed information about a Log Entry resource.", "description": "Available since: 6.0.0.0", "operationId": "getLogEntry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Log Entry" ], "summary": "Delete a Log Entry resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteLogEntry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Log Entry" ], "summary": "Partially update information about a Log Entry resource.", "description": "Available since: 6.0.0.0", "operationId": "updateLogEntry", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Log Entry resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LogEntry" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/log-entry": { "post": { "tags": [ "Log Entry" ], "summary": "Aggregate for the Log Entry resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateLogEntry", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of LogEntry", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntry" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-header-footer": { "get": { "tags": [ "Mail Header Footer" ], "summary": "List with basic information of Mail Header Footer resources.", "description": "Available since: 6.0.0.0", "operationId": "getMailHeaderFooterList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Mail Header Footer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/mail-header-footer?limit=25" }, "last": { "example": "/mail-header-footer?limit=25&page=11" }, "next": { "example": "/mail-header-footer?limit=25&page=4" }, "prev": { "example": "/mail-header-footer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Mail Header Footer" ], "summary": "Create a new Mail Header Footer resources.", "description": "Available since: 6.0.0.0", "operationId": "createMailHeaderFooter", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/mail-header-footer": { "post": { "tags": [ "Mail Header Footer" ], "summary": "Search for the Mail Header Footer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailHeaderFooter", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-header-footer/{id}": { "get": { "tags": [ "Mail Header Footer" ], "summary": "Detailed information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", "operationId": "getMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Mail Header Footer" ], "summary": "Delete a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Mail Header Footer" ], "summary": "Partially update information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Mail Header Footer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/mail-header-footer": { "post": { "tags": [ "Mail Header Footer" ], "summary": "Aggregate for the Mail Header Footer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMailHeaderFooter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailHeaderFooter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-template": { "get": { "tags": [ "Mail Template" ], "summary": "List with basic information of Mail Template resources.", "description": "Available since: 6.0.0.0", "operationId": "getMailTemplateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Mail Template resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/mail-template?limit=25" }, "last": { "example": "/mail-template?limit=25&page=11" }, "next": { "example": "/mail-template?limit=25&page=4" }, "prev": { "example": "/mail-template?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Mail Template" ], "summary": "Create a new Mail Template resources.", "description": "Available since: 6.0.0.0", "operationId": "createMailTemplate", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/mail-template": { "post": { "tags": [ "Mail Template" ], "summary": "Search for the Mail Template resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailTemplate", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MailTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-template/{id}": { "get": { "tags": [ "Mail Template" ], "summary": "Detailed information about a Mail Template resource.", "description": "Available since: 6.0.0.0", "operationId": "getMailTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Mail Template" ], "summary": "Delete a Mail Template resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMailTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Mail Template" ], "summary": "Partially update information about a Mail Template resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMailTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Mail Template resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/mail-template": { "post": { "tags": [ "Mail Template" ], "summary": "Aggregate for the Mail Template resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMailTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MailTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-template-type": { "get": { "tags": [ "Mail Template Type" ], "summary": "List with basic information of Mail Template Type resources.", "description": "Available since: 6.0.0.0", "operationId": "getMailTemplateTypeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Mail Template Type resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/mail-template-type?limit=25" }, "last": { "example": "/mail-template-type?limit=25&page=11" }, "next": { "example": "/mail-template-type?limit=25&page=4" }, "prev": { "example": "/mail-template-type?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Mail Template Type" ], "summary": "Create a new Mail Template Type resources.", "description": "Available since: 6.0.0.0", "operationId": "createMailTemplateType", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/mail-template-type": { "post": { "tags": [ "Mail Template Type" ], "summary": "Search for the Mail Template Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailTemplateType", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/mail-template-type/{id}": { "get": { "tags": [ "Mail Template Type" ], "summary": "Detailed information about a Mail Template Type resource.", "description": "Available since: 6.0.0.0", "operationId": "getMailTemplateType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Mail Template Type" ], "summary": "Delete a Mail Template Type resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMailTemplateType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Mail Template Type" ], "summary": "Partially update information about a Mail Template Type resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMailTemplateType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Mail Template Type resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailTemplateType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/mail-template-type": { "post": { "tags": [ "Mail Template Type" ], "summary": "Aggregate for the Mail Template Type resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMailTemplateType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/main-category": { "get": { "tags": [ "Main Category" ], "summary": "List with basic information of Main Category resources.", "description": "Available since: 6.1.0.0", "operationId": "getMainCategoryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Main Category resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/main-category?limit=25" }, "last": { "example": "/main-category?limit=25&page=11" }, "next": { "example": "/main-category?limit=25&page=4" }, "prev": { "example": "/main-category?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Main Category" ], "summary": "Create a new Main Category resources.", "description": "Available since: 6.1.0.0", "operationId": "createMainCategory", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/main-category": { "post": { "tags": [ "Main Category" ], "summary": "Search for the Main Category resources.", "description": "Available since: 6.1.0.0", "operationId": "searchMainCategory", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MainCategory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/main-category/{id}": { "get": { "tags": [ "Main Category" ], "summary": "Detailed information about a Main Category resource.", "description": "Available since: 6.1.0.0", "operationId": "getMainCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Main Category" ], "summary": "Delete a Main Category resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteMainCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Main Category" ], "summary": "Partially update information about a Main Category resource.", "description": "Available since: 6.1.0.0", "operationId": "updateMainCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Main Category resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MainCategory" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/main-category": { "post": { "tags": [ "Main Category" ], "summary": "Aggregate for the Main Category resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMainCategory", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MainCategory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/measurement-display-unit": { "get": { "tags": [ "Measurement Display Unit" ], "summary": "List with basic information of Measurement Display Unit resources.", "description": "Available since: 6.7.1.0", "operationId": "getMeasurementDisplayUnitList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Measurement Display Unit resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/measurement-display-unit?limit=25" }, "last": { "example": "/measurement-display-unit?limit=25&page=11" }, "next": { "example": "/measurement-display-unit?limit=25&page=4" }, "prev": { "example": "/measurement-display-unit?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Measurement Display Unit" ], "summary": "Create a new Measurement Display Unit resources.", "description": "Available since: 6.7.1.0", "operationId": "createMeasurementDisplayUnit", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } }, "responses": { "200": { "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/measurement-display-unit": { "post": { "tags": [ "Measurement Display Unit" ], "summary": "Search for the Measurement Display Unit resources.", "description": "Available since: 6.7.1.0", "operationId": "searchMeasurementDisplayUnit", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/measurement-display-unit/{id}": { "get": { "tags": [ "Measurement Display Unit" ], "summary": "Detailed information about a Measurement Display Unit resource.", "description": "Available since: 6.7.1.0", "operationId": "getMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Measurement Display Unit" ], "summary": "Delete a Measurement Display Unit resource.", "description": "Available since: 6.7.1.0", "operationId": "deleteMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Measurement Display Unit" ], "summary": "Partially update information about a Measurement Display Unit resource.", "description": "Available since: 6.7.1.0", "operationId": "updateMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Measurement Display Unit resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } }, "responses": { "200": { "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/measurement-display-unit": { "post": { "tags": [ "Measurement Display Unit" ], "summary": "Aggregate for the Measurement Display Unit resources.", "description": "Available since: 6.7.1.0", "operationId": "aggregateMeasurementDisplayUnit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/measurement-system": { "get": { "tags": [ "Measurement System" ], "summary": "List with basic information of Measurement System resources.", "description": "Available since: 6.7.1.0", "operationId": "getMeasurementSystemList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Measurement System resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/measurement-system?limit=25" }, "last": { "example": "/measurement-system?limit=25&page=11" }, "next": { "example": "/measurement-system?limit=25&page=4" }, "prev": { "example": "/measurement-system?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Measurement System" ], "summary": "Create a new Measurement System resources.", "description": "Available since: 6.7.1.0", "operationId": "createMeasurementSystem", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementSystem" } } } }, "responses": { "200": { "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/measurement-system": { "post": { "tags": [ "Measurement System" ], "summary": "Search for the Measurement System resources.", "description": "Available since: 6.7.1.0", "operationId": "searchMeasurementSystem", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/measurement-system/{id}": { "get": { "tags": [ "Measurement System" ], "summary": "Detailed information about a Measurement System resource.", "description": "Available since: 6.7.1.0", "operationId": "getMeasurementSystem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Measurement System" ], "summary": "Delete a Measurement System resource.", "description": "Available since: 6.7.1.0", "operationId": "deleteMeasurementSystem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Measurement System" ], "summary": "Partially update information about a Measurement System resource.", "description": "Available since: 6.7.1.0", "operationId": "updateMeasurementSystem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Measurement System resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementSystem" } } } }, "responses": { "200": { "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/measurement-system": { "post": { "tags": [ "Measurement System" ], "summary": "Aggregate for the Measurement System resources.", "description": "Available since: 6.7.1.0", "operationId": "aggregateMeasurementSystem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSystem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media": { "get": { "tags": [ "Media" ], "summary": "List with basic information of Media resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media?limit=25" }, "last": { "example": "/media?limit=25&page=11" }, "next": { "example": "/media?limit=25&page=4" }, "prev": { "example": "/media?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media" ], "summary": "Create a new Media resources.", "description": "Available since: 6.0.0.0", "operationId": "createMedia", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Media" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Media" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media": { "post": { "tags": [ "Media" ], "summary": "Search for the Media resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMedia", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Media", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media/{id}": { "get": { "tags": [ "Media" ], "summary": "Detailed information about a Media resource.", "description": "Available since: 6.0.0.0", "operationId": "getMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Media" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Media" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media" ], "summary": "Delete a Media resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media" ], "summary": "Partially update information about a Media resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Media" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Media" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media": { "post": { "tags": [ "Media" ], "summary": "Aggregate for the Media resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMedia", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Media", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-default-folder": { "get": { "tags": [ "Media Default Folder" ], "summary": "List with basic information of Media Default Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaDefaultFolderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Default Folder resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-default-folder?limit=25" }, "last": { "example": "/media-default-folder?limit=25&page=11" }, "next": { "example": "/media-default-folder?limit=25&page=4" }, "prev": { "example": "/media-default-folder?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media Default Folder" ], "summary": "Create a new Media Default Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "createMediaDefaultFolder", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-default-folder": { "post": { "tags": [ "Media Default Folder" ], "summary": "Search for the Media Default Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaDefaultFolder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-default-folder/{id}": { "get": { "tags": [ "Media Default Folder" ], "summary": "Detailed information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "getMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media Default Folder" ], "summary": "Delete a Media Default Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media Default Folder" ], "summary": "Partially update information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Default Folder resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media-default-folder": { "post": { "tags": [ "Media Default Folder" ], "summary": "Aggregate for the Media Default Folder resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaDefaultFolder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaDefaultFolder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-folder": { "get": { "tags": [ "Media Folder" ], "summary": "List with basic information of Media Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaFolderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Folder resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-folder?limit=25" }, "last": { "example": "/media-folder?limit=25&page=11" }, "next": { "example": "/media-folder?limit=25&page=4" }, "prev": { "example": "/media-folder?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media Folder" ], "summary": "Create a new Media Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "createMediaFolder", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-folder": { "post": { "tags": [ "Media Folder" ], "summary": "Search for the Media Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaFolder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MediaFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-folder/{id}": { "get": { "tags": [ "Media Folder" ], "summary": "Detailed information about a Media Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "getMediaFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media Folder" ], "summary": "Delete a Media Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMediaFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media Folder" ], "summary": "Partially update information about a Media Folder resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMediaFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Folder resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media-folder": { "post": { "tags": [ "Media Folder" ], "summary": "Aggregate for the Media Folder resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaFolder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MediaFolder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-folder-configuration": { "get": { "tags": [ "Media Folder Configuration" ], "summary": "List with basic information of Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaFolderConfigurationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Folder Configuration resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-folder-configuration?limit=25" }, "last": { "example": "/media-folder-configuration?limit=25&page=11" }, "next": { "example": "/media-folder-configuration?limit=25&page=4" }, "prev": { "example": "/media-folder-configuration?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media Folder Configuration" ], "summary": "Create a new Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", "operationId": "createMediaFolderConfiguration", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-folder-configuration": { "post": { "tags": [ "Media Folder Configuration" ], "summary": "Search for the Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaFolderConfiguration", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-folder-configuration/{id}": { "get": { "tags": [ "Media Folder Configuration" ], "summary": "Detailed information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", "operationId": "getMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media Folder Configuration" ], "summary": "Delete a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media Folder Configuration" ], "summary": "Partially update information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Folder Configuration resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media-folder-configuration": { "post": { "tags": [ "Media Folder Configuration" ], "summary": "Aggregate for the Media Folder Configuration resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaFolderConfiguration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-thumbnail": { "get": { "tags": [ "Media Thumbnail" ], "summary": "List with basic information of Media Thumbnail resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaThumbnailList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Thumbnail resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-thumbnail?limit=25" }, "last": { "example": "/media-thumbnail?limit=25&page=11" }, "next": { "example": "/media-thumbnail?limit=25&page=4" }, "prev": { "example": "/media-thumbnail?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media Thumbnail" ], "summary": "Create a new Media Thumbnail resources.", "description": "Available since: 6.0.0.0", "operationId": "createMediaThumbnail", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-thumbnail": { "post": { "tags": [ "Media Thumbnail" ], "summary": "Search for the Media Thumbnail resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaThumbnail", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-thumbnail/{id}": { "get": { "tags": [ "Media Thumbnail" ], "summary": "Detailed information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", "operationId": "getMediaThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media Thumbnail" ], "summary": "Delete a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMediaThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media Thumbnail" ], "summary": "Partially update information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMediaThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Thumbnail resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media-thumbnail": { "post": { "tags": [ "Media Thumbnail" ], "summary": "Aggregate for the Media Thumbnail resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaThumbnail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-thumbnail-size": { "get": { "tags": [ "Media Thumbnail Size" ], "summary": "List with basic information of Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", "operationId": "getMediaThumbnailSizeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Thumbnail Size resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-thumbnail-size?limit=25" }, "last": { "example": "/media-thumbnail-size?limit=25&page=11" }, "next": { "example": "/media-thumbnail-size?limit=25&page=4" }, "prev": { "example": "/media-thumbnail-size?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Media Thumbnail Size" ], "summary": "Create a new Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", "operationId": "createMediaThumbnailSize", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-thumbnail-size": { "post": { "tags": [ "Media Thumbnail Size" ], "summary": "Search for the Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaThumbnailSize", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-thumbnail-size/{id}": { "get": { "tags": [ "Media Thumbnail Size" ], "summary": "Detailed information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", "operationId": "getMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Media Thumbnail Size" ], "summary": "Delete a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Media Thumbnail Size" ], "summary": "Partially update information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", "operationId": "updateMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Thumbnail Size resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/media-thumbnail-size": { "post": { "tags": [ "Media Thumbnail Size" ], "summary": "Aggregate for the Media Thumbnail Size resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaThumbnailSize", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/newsletter-recipient": { "get": { "tags": [ "Newsletter Recipient" ], "summary": "List with basic information of Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", "operationId": "getNewsletterRecipientList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Newsletter Recipient resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/newsletter-recipient?limit=25" }, "last": { "example": "/newsletter-recipient?limit=25&page=11" }, "next": { "example": "/newsletter-recipient?limit=25&page=4" }, "prev": { "example": "/newsletter-recipient?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Newsletter Recipient" ], "summary": "Create a new Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", "operationId": "createNewsletterRecipient", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/newsletter-recipient": { "post": { "tags": [ "Newsletter Recipient" ], "summary": "Search for the Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNewsletterRecipient", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/newsletter-recipient/{id}": { "get": { "tags": [ "Newsletter Recipient" ], "summary": "Detailed information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", "operationId": "getNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Newsletter Recipient" ], "summary": "Delete a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Newsletter Recipient" ], "summary": "Partially update information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", "operationId": "updateNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Newsletter Recipient resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/newsletter-recipient": { "post": { "tags": [ "Newsletter Recipient" ], "summary": "Aggregate for the Newsletter Recipient resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNewsletterRecipient", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notification": { "get": { "tags": [ "Notification" ], "summary": "List with basic information of Notification resources.", "description": "Available since: 6.4.7.0", "operationId": "getNotificationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Notification resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/notification?limit=25" }, "last": { "example": "/notification?limit=25&page=11" }, "next": { "example": "/notification?limit=25&page=4" }, "prev": { "example": "/notification?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Notification" ], "summary": "Create a new Notification resources.", "description": "Available since: 6.4.7.0", "operationId": "createNotification", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/notification": { "post": { "tags": [ "Notification" ], "summary": "Search for the Notification resources.", "description": "Available since: 6.4.7.0", "operationId": "searchNotification", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Notification", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notification/{id}": { "get": { "tags": [ "Notification" ], "summary": "Detailed information about a Notification resource.", "description": "Available since: 6.4.7.0", "operationId": "getNotification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the notification", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Notification" ], "summary": "Delete a Notification resource.", "description": "Available since: 6.4.7.0", "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the notification", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Notification" ], "summary": "Partially update information about a Notification resource.", "description": "Available since: 6.4.7.0", "operationId": "updateNotification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the notification", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Notification resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Notification" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/notification": { "post": { "tags": [ "Notification" ], "summary": "Aggregate for the Notification resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNotification", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Notification", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range": { "get": { "tags": [ "Number Range" ], "summary": "List with basic information of Number Range resources.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Number Range resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/number-range?limit=25" }, "last": { "example": "/number-range?limit=25&page=11" }, "next": { "example": "/number-range?limit=25&page=4" }, "prev": { "example": "/number-range?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Number Range" ], "summary": "Create a new Number Range resources.", "description": "Available since: 6.0.0.0", "operationId": "createNumberRange", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/number-range": { "post": { "tags": [ "Number Range" ], "summary": "Search for the Number Range resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRange", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of NumberRange", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range/{id}": { "get": { "tags": [ "Number Range" ], "summary": "Detailed information about a Number Range resource.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRange", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Number Range" ], "summary": "Delete a Number Range resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteNumberRange", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Number Range" ], "summary": "Partially update information about a Number Range resource.", "description": "Available since: 6.0.0.0", "operationId": "updateNumberRange", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Number Range resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRange" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/number-range": { "post": { "tags": [ "Number Range" ], "summary": "Aggregate for the Number Range resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNumberRange", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of NumberRange", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-sales-channel": { "get": { "tags": [ "Number Range Sales Channel" ], "summary": "List with basic information of Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Number Range Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/number-range-sales-channel?limit=25" }, "last": { "example": "/number-range-sales-channel?limit=25&page=11" }, "next": { "example": "/number-range-sales-channel?limit=25&page=4" }, "prev": { "example": "/number-range-sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Number Range Sales Channel" ], "summary": "Create a new Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "createNumberRangeSalesChannel", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/number-range-sales-channel": { "post": { "tags": [ "Number Range Sales Channel" ], "summary": "Search for the Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-sales-channel/{id}": { "get": { "tags": [ "Number Range Sales Channel" ], "summary": "Detailed information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Number Range Sales Channel" ], "summary": "Delete a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Number Range Sales Channel" ], "summary": "Partially update information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "updateNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Number Range Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/number-range-sales-channel": { "post": { "tags": [ "Number Range Sales Channel" ], "summary": "Aggregate for the Number Range Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNumberRangeSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-state": { "get": { "tags": [ "Number Range State" ], "summary": "List with basic information of Number Range State resources.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeStateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Number Range State resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/number-range-state?limit=25" }, "last": { "example": "/number-range-state?limit=25&page=11" }, "next": { "example": "/number-range-state?limit=25&page=4" }, "prev": { "example": "/number-range-state?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Number Range State" ], "summary": "Create a new Number Range State resources.", "description": "Available since: 6.0.0.0", "operationId": "createNumberRangeState", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/number-range-state": { "post": { "tags": [ "Number Range State" ], "summary": "Search for the Number Range State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeState", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-state/{id}": { "get": { "tags": [ "Number Range State" ], "summary": "Detailed information about a Number Range State resource.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Number Range State" ], "summary": "Delete a Number Range State resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteNumberRangeState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Number Range State" ], "summary": "Partially update information about a Number Range State resource.", "description": "Available since: 6.0.0.0", "operationId": "updateNumberRangeState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Number Range State resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/number-range-state": { "post": { "tags": [ "Number Range State" ], "summary": "Aggregate for the Number Range State resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNumberRangeState", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-type": { "get": { "tags": [ "Number Range Type" ], "summary": "List with basic information of Number Range Type resources.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeTypeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Number Range Type resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/number-range-type?limit=25" }, "last": { "example": "/number-range-type?limit=25&page=11" }, "next": { "example": "/number-range-type?limit=25&page=4" }, "prev": { "example": "/number-range-type?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Number Range Type" ], "summary": "Create a new Number Range Type resources.", "description": "Available since: 6.0.0.0", "operationId": "createNumberRangeType", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/number-range-type": { "post": { "tags": [ "Number Range Type" ], "summary": "Search for the Number Range Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeType", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/number-range-type/{id}": { "get": { "tags": [ "Number Range Type" ], "summary": "Detailed information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", "operationId": "getNumberRangeType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Number Range Type" ], "summary": "Delete a Number Range Type resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteNumberRangeType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Number Range Type" ], "summary": "Partially update information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", "operationId": "updateNumberRangeType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Number Range Type resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/NumberRangeType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/number-range-type": { "post": { "tags": [ "Number Range Type" ], "summary": "Aggregate for the Number Range Type resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateNumberRangeType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order": { "get": { "tags": [ "Order" ], "summary": "List with basic information of Order resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order?limit=25" }, "last": { "example": "/order?limit=25&page=11" }, "next": { "example": "/order?limit=25&page=4" }, "prev": { "example": "/order?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order" ], "summary": "Create a new Order resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrder", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order": { "post": { "tags": [ "Order" ], "summary": "Search for the Order resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Order", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order/{id}": { "get": { "tags": [ "Order" ], "summary": "Detailed information about a Order resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order" ], "summary": "Delete a Order resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order" ], "summary": "Partially update information about a Order resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order": { "post": { "tags": [ "Order" ], "summary": "Aggregate for the Order resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Order", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-address": { "get": { "tags": [ "Order Address" ], "summary": "List with basic information of Order Address resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderAddressList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Address resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-address?limit=25" }, "last": { "example": "/order-address?limit=25&page=11" }, "next": { "example": "/order-address?limit=25&page=4" }, "prev": { "example": "/order-address?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Address" ], "summary": "Create a new Order Address resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderAddress", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-address": { "post": { "tags": [ "Order Address" ], "summary": "Search for the Order Address resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderAddress", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-address/{id}": { "get": { "tags": [ "Order Address" ], "summary": "Detailed information about a Order Address resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Address" ], "summary": "Delete a Order Address resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Address" ], "summary": "Partially update information about a Order Address resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Address resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-address": { "post": { "tags": [ "Order Address" ], "summary": "Aggregate for the Order Address resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderAddress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-customer": { "get": { "tags": [ "Order Customer" ], "summary": "List with basic information of Order Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Customer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-customer?limit=25" }, "last": { "example": "/order-customer?limit=25&page=11" }, "next": { "example": "/order-customer?limit=25&page=4" }, "prev": { "example": "/order-customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Customer" ], "summary": "Create a new Order Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderCustomer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-customer": { "post": { "tags": [ "Order Customer" ], "summary": "Search for the Order Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-customer/{id}": { "get": { "tags": [ "Order Customer" ], "summary": "Detailed information about a Order Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Customer" ], "summary": "Delete a Order Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Customer" ], "summary": "Partially update information about a Order Customer resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-customer": { "post": { "tags": [ "Order Customer" ], "summary": "Aggregate for the Order Customer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-delivery": { "get": { "tags": [ "Order Delivery" ], "summary": "List with basic information of Order Delivery resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderDeliveryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Delivery resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-delivery?limit=25" }, "last": { "example": "/order-delivery?limit=25&page=11" }, "next": { "example": "/order-delivery?limit=25&page=4" }, "prev": { "example": "/order-delivery?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Delivery" ], "summary": "Create a new Order Delivery resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderDelivery", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-delivery": { "post": { "tags": [ "Order Delivery" ], "summary": "Search for the Order Delivery resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderDelivery", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-delivery/{id}": { "get": { "tags": [ "Order Delivery" ], "summary": "Detailed information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Delivery" ], "summary": "Delete a Order Delivery resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Delivery" ], "summary": "Partially update information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Delivery resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDelivery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-delivery": { "post": { "tags": [ "Order Delivery" ], "summary": "Aggregate for the Order Delivery resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderDelivery", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-delivery-position": { "get": { "tags": [ "Order Delivery Position" ], "summary": "List with basic information of Order Delivery Position resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderDeliveryPositionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-delivery-position?limit=25" }, "last": { "example": "/order-delivery-position?limit=25&page=11" }, "next": { "example": "/order-delivery-position?limit=25&page=4" }, "prev": { "example": "/order-delivery-position?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Delivery Position" ], "summary": "Create a new Order Delivery Position resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderDeliveryPosition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-delivery-position": { "post": { "tags": [ "Order Delivery Position" ], "summary": "Search for the Order Delivery Position resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderDeliveryPosition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-delivery-position/{id}": { "get": { "tags": [ "Order Delivery Position" ], "summary": "Detailed information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Delivery Position" ], "summary": "Delete a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Delivery Position" ], "summary": "Partially update information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Delivery Position resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-delivery-position": { "post": { "tags": [ "Order Delivery Position" ], "summary": "Aggregate for the Order Delivery Position resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderDeliveryPosition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-line-item": { "get": { "tags": [ "Order Line Item" ], "summary": "List with basic information of Order Line Item resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderLineItemList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Line Item resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-line-item?limit=25" }, "last": { "example": "/order-line-item?limit=25&page=11" }, "next": { "example": "/order-line-item?limit=25&page=4" }, "prev": { "example": "/order-line-item?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Line Item" ], "summary": "Create a new Order Line Item resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderLineItem", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-line-item": { "post": { "tags": [ "Order Line Item" ], "summary": "Search for the Order Line Item resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderLineItem", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-line-item/{id}": { "get": { "tags": [ "Order Line Item" ], "summary": "Detailed information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Line Item" ], "summary": "Delete a Order Line Item resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Line Item" ], "summary": "Partially update information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Line Item resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-line-item": { "post": { "tags": [ "Order Line Item" ], "summary": "Aggregate for the Order Line Item resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderLineItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-line-item-download": { "get": { "tags": [ "Order Line Item Download" ], "summary": "List with basic information of Order Line Item Download resources.", "description": "Available since: 6.4.19.0", "operationId": "getOrderLineItemDownloadList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Line Item Download resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-line-item-download?limit=25" }, "last": { "example": "/order-line-item-download?limit=25&page=11" }, "next": { "example": "/order-line-item-download?limit=25&page=4" }, "prev": { "example": "/order-line-item-download?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Line Item Download" ], "summary": "Create a new Order Line Item Download resources.", "description": "Available since: 6.4.19.0", "operationId": "createOrderLineItemDownload", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-line-item-download": { "post": { "tags": [ "Order Line Item Download" ], "summary": "Search for the Order Line Item Download resources.", "description": "Available since: 6.4.19.0", "operationId": "searchOrderLineItemDownload", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-line-item-download/{id}": { "get": { "tags": [ "Order Line Item Download" ], "summary": "Detailed information about a Order Line Item Download resource.", "description": "Available since: 6.4.19.0", "operationId": "getOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Line Item Download" ], "summary": "Delete a Order Line Item Download resource.", "description": "Available since: 6.4.19.0", "operationId": "deleteOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Line Item Download" ], "summary": "Partially update information about a Order Line Item Download resource.", "description": "Available since: 6.4.19.0", "operationId": "updateOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Line Item Download resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-line-item-download": { "post": { "tags": [ "Order Line Item Download" ], "summary": "Aggregate for the Order Line Item Download resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderLineItemDownload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction": { "get": { "tags": [ "Order Transaction" ], "summary": "List with basic information of Order Transaction resources.", "description": "Available since: 6.0.0.0", "operationId": "getOrderTransactionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Transaction resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-transaction?limit=25" }, "last": { "example": "/order-transaction?limit=25&page=11" }, "next": { "example": "/order-transaction?limit=25&page=4" }, "prev": { "example": "/order-transaction?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Transaction" ], "summary": "Create a new Order Transaction resources.", "description": "Available since: 6.0.0.0", "operationId": "createOrderTransaction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-transaction": { "post": { "tags": [ "Order Transaction" ], "summary": "Search for the Order Transaction resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderTransaction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction/{id}": { "get": { "tags": [ "Order Transaction" ], "summary": "Detailed information about a Order Transaction resource.", "description": "Available since: 6.0.0.0", "operationId": "getOrderTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Transaction" ], "summary": "Delete a Order Transaction resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteOrderTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Transaction" ], "summary": "Partially update information about a Order Transaction resource.", "description": "Available since: 6.0.0.0", "operationId": "updateOrderTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Transaction resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransaction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-transaction": { "post": { "tags": [ "Order Transaction" ], "summary": "Aggregate for the Order Transaction resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderTransaction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture": { "get": { "tags": [ "Order Transaction Capture" ], "summary": "List with basic information of Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCaptureList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Transaction Capture resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-transaction-capture?limit=25" }, "last": { "example": "/order-transaction-capture?limit=25&page=11" }, "next": { "example": "/order-transaction-capture?limit=25&page=4" }, "prev": { "example": "/order-transaction-capture?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Transaction Capture" ], "summary": "Create a new Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", "operationId": "createOrderTransactionCapture", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-transaction-capture": { "post": { "tags": [ "Order Transaction Capture" ], "summary": "Search for the Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCapture", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture/{id}": { "get": { "tags": [ "Order Transaction Capture" ], "summary": "Detailed information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Transaction Capture" ], "summary": "Delete a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", "operationId": "deleteOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Transaction Capture" ], "summary": "Partially update information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", "operationId": "updateOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Transaction Capture resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-transaction-capture": { "post": { "tags": [ "Order Transaction Capture" ], "summary": "Aggregate for the Order Transaction Capture resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderTransactionCapture", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture-refund": { "get": { "tags": [ "Order Transaction Capture Refund" ], "summary": "List with basic information of Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCaptureRefundList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Transaction Capture Refund resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-transaction-capture-refund?limit=25" }, "last": { "example": "/order-transaction-capture-refund?limit=25&page=11" }, "next": { "example": "/order-transaction-capture-refund?limit=25&page=4" }, "prev": { "example": "/order-transaction-capture-refund?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Create a new Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", "operationId": "createOrderTransactionCaptureRefund", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-transaction-capture-refund": { "post": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Search for the Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCaptureRefund", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture-refund/{id}": { "get": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Detailed information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Delete a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", "operationId": "deleteOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Partially update information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", "operationId": "updateOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Transaction Capture Refund resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-transaction-capture-refund": { "post": { "tags": [ "Order Transaction Capture Refund" ], "summary": "Aggregate for the Order Transaction Capture Refund resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderTransactionCaptureRefund", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture-refund-position": { "get": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "List with basic information of Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCaptureRefundPositionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Transaction Capture Refund Position resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-transaction-capture-refund-position?limit=25" }, "last": { "example": "/order-transaction-capture-refund-position?limit=25&page=11" }, "next": { "example": "/order-transaction-capture-refund-position?limit=25&page=4" }, "prev": { "example": "/order-transaction-capture-refund-position?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Create a new Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", "operationId": "createOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-transaction-capture-refund-position": { "post": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Search for the Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-transaction-capture-refund-position/{id}": { "get": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", "operationId": "getOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Delete a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", "operationId": "deleteOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", "operationId": "updateOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Transaction Capture Refund Position resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/order-transaction-capture-refund-position": { "post": { "tags": [ "Order Transaction Capture Refund Position" ], "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderTransactionCaptureRefundPosition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/payment-method": { "get": { "tags": [ "Payment Method" ], "summary": "List with basic information of Payment Method resources.", "description": "Available since: 6.0.0.0", "operationId": "getPaymentMethodList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Payment Method resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/payment-method?limit=25" }, "last": { "example": "/payment-method?limit=25&page=11" }, "next": { "example": "/payment-method?limit=25&page=4" }, "prev": { "example": "/payment-method?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Payment Method" ], "summary": "Create a new Payment Method resources.", "description": "Available since: 6.0.0.0", "operationId": "createPaymentMethod", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/payment-method": { "post": { "tags": [ "Payment Method" ], "summary": "Search for the Payment Method resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPaymentMethod", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/payment-method/{id}": { "get": { "tags": [ "Payment Method" ], "summary": "Detailed information about a Payment Method resource.", "description": "Available since: 6.0.0.0", "operationId": "getPaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Payment Method" ], "summary": "Delete a Payment Method resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Payment Method" ], "summary": "Partially update information about a Payment Method resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Payment Method resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PaymentMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/payment-method": { "post": { "tags": [ "Payment Method" ], "summary": "Aggregate for the Payment Method resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePaymentMethod", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/plugin": { "get": { "tags": [ "Plugin" ], "summary": "List with basic information of Plugin resources.", "description": "Available since: 6.0.0.0", "operationId": "getPluginList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Plugin resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/plugin?limit=25" }, "last": { "example": "/plugin?limit=25&page=11" }, "next": { "example": "/plugin?limit=25&page=4" }, "prev": { "example": "/plugin?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Plugin" ], "summary": "Create a new Plugin resources.", "description": "Available since: 6.0.0.0", "operationId": "createPlugin", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/plugin": { "post": { "tags": [ "Plugin" ], "summary": "Search for the Plugin resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPlugin", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Plugin", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/plugin/{id}": { "get": { "tags": [ "Plugin" ], "summary": "Detailed information about a Plugin resource.", "description": "Available since: 6.0.0.0", "operationId": "getPlugin", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Plugin" ], "summary": "Delete a Plugin resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePlugin", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Plugin" ], "summary": "Partially update information about a Plugin resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePlugin", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Plugin resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Plugin" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/plugin": { "post": { "tags": [ "Plugin" ], "summary": "Aggregate for the Plugin resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePlugin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Plugin", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plugin" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product": { "get": { "tags": [ "Product" ], "summary": "List with basic information of Product resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product?limit=25" }, "last": { "example": "/product?limit=25&page=11" }, "next": { "example": "/product?limit=25&page=4" }, "prev": { "example": "/product?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product" ], "summary": "Create a new Product resources.", "description": "Available since: 6.0.0.0", "operationId": "createProduct", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Product" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Product" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product": { "post": { "tags": [ "Product" ], "summary": "Search for the Product resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProduct", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Product", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product/{id}": { "get": { "tags": [ "Product" ], "summary": "Detailed information about a Product resource.", "description": "Available since: 6.0.0.0", "operationId": "getProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Product" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Product" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product" ], "summary": "Delete a Product resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product" ], "summary": "Partially update information about a Product resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Product" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Product" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product": { "post": { "tags": [ "Product" ], "summary": "Aggregate for the Product resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Product", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-configurator-setting": { "get": { "tags": [ "Product Configurator Setting" ], "summary": "List with basic information of Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductConfiguratorSettingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Configurator Setting resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-configurator-setting?limit=25" }, "last": { "example": "/product-configurator-setting?limit=25&page=11" }, "next": { "example": "/product-configurator-setting?limit=25&page=4" }, "prev": { "example": "/product-configurator-setting?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Configurator Setting" ], "summary": "Create a new Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductConfiguratorSetting", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-configurator-setting": { "post": { "tags": [ "Product Configurator Setting" ], "summary": "Search for the Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductConfiguratorSetting", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-configurator-setting/{id}": { "get": { "tags": [ "Product Configurator Setting" ], "summary": "Detailed information about a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Configurator Setting" ], "summary": "Delete a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Configurator Setting" ], "summary": "Partially update information about a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Configurator Setting resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-configurator-setting": { "post": { "tags": [ "Product Configurator Setting" ], "summary": "Aggregate for the Product Configurator Setting resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductConfiguratorSetting", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-cross-selling": { "get": { "tags": [ "Product Cross Selling" ], "summary": "List with basic information of Product Cross Selling resources.", "description": "Available since: 6.1.0.0", "operationId": "getProductCrossSellingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Cross Selling resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-cross-selling?limit=25" }, "last": { "example": "/product-cross-selling?limit=25&page=11" }, "next": { "example": "/product-cross-selling?limit=25&page=4" }, "prev": { "example": "/product-cross-selling?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Cross Selling" ], "summary": "Create a new Product Cross Selling resources.", "description": "Available since: 6.1.0.0", "operationId": "createProductCrossSelling", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-cross-selling": { "post": { "tags": [ "Product Cross Selling" ], "summary": "Search for the Product Cross Selling resources.", "description": "Available since: 6.1.0.0", "operationId": "searchProductCrossSelling", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-cross-selling/{id}": { "get": { "tags": [ "Product Cross Selling" ], "summary": "Detailed information about a Product Cross Selling resource.", "description": "Available since: 6.1.0.0", "operationId": "getProductCrossSelling", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Cross Selling" ], "summary": "Delete a Product Cross Selling resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteProductCrossSelling", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Cross Selling" ], "summary": "Partially update information about a Product Cross Selling resource.", "description": "Available since: 6.1.0.0", "operationId": "updateProductCrossSelling", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Cross Selling resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-cross-selling": { "post": { "tags": [ "Product Cross Selling" ], "summary": "Aggregate for the Product Cross Selling resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductCrossSelling", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-cross-selling-assigned-products": { "get": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "List with basic information of Product Cross Selling Assigned Products resources.", "description": "Available since: 6.2.0.0", "operationId": "getProductCrossSellingAssignedProductsList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Cross Selling Assigned Products resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-cross-selling-assigned-products?limit=25" }, "last": { "example": "/product-cross-selling-assigned-products?limit=25&page=11" }, "next": { "example": "/product-cross-selling-assigned-products?limit=25&page=4" }, "prev": { "example": "/product-cross-selling-assigned-products?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Create a new Product Cross Selling Assigned Products resources.", "description": "Available since: 6.2.0.0", "operationId": "createProductCrossSellingAssignedProducts", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-cross-selling-assigned-products": { "post": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Search for the Product Cross Selling Assigned Products resources.", "description": "Available since: 6.2.0.0", "operationId": "searchProductCrossSellingAssignedProducts", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-cross-selling-assigned-products/{id}": { "get": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", "description": "Available since: 6.2.0.0", "operationId": "getProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Delete a Product Cross Selling Assigned Products resource.", "description": "Available since: 6.2.0.0", "operationId": "deleteProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", "description": "Available since: 6.2.0.0", "operationId": "updateProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Cross Selling Assigned Products resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-cross-selling-assigned-products": { "post": { "tags": [ "Product Cross Selling Assigned Products" ], "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductCrossSellingAssignedProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-download": { "get": { "tags": [ "Product Download" ], "summary": "List with basic information of Product Download resources.", "description": "Available since: 6.4.19.0", "operationId": "getProductDownloadList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Download resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-download?limit=25" }, "last": { "example": "/product-download?limit=25&page=11" }, "next": { "example": "/product-download?limit=25&page=4" }, "prev": { "example": "/product-download?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Download" ], "summary": "Create a new Product Download resources.", "description": "Available since: 6.4.19.0", "operationId": "createProductDownload", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-download": { "post": { "tags": [ "Product Download" ], "summary": "Search for the Product Download resources.", "description": "Available since: 6.4.19.0", "operationId": "searchProductDownload", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-download/{id}": { "get": { "tags": [ "Product Download" ], "summary": "Detailed information about a Product Download resource.", "description": "Available since: 6.4.19.0", "operationId": "getProductDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Download" ], "summary": "Delete a Product Download resource.", "description": "Available since: 6.4.19.0", "operationId": "deleteProductDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Download" ], "summary": "Partially update information about a Product Download resource.", "description": "Available since: 6.4.19.0", "operationId": "updateProductDownload", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Download resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductDownload" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-download": { "post": { "tags": [ "Product Download" ], "summary": "Aggregate for the Product Download resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductDownload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductDownload", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-export": { "get": { "tags": [ "Product Export" ], "summary": "List with basic information of Product Export resources.", "description": "Available since: 6.1.0.0", "operationId": "getProductExportList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Export resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-export?limit=25" }, "last": { "example": "/product-export?limit=25&page=11" }, "next": { "example": "/product-export?limit=25&page=4" }, "prev": { "example": "/product-export?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Export" ], "summary": "Create a new Product Export resources.", "description": "Available since: 6.1.0.0", "operationId": "createProductExport", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-export": { "post": { "tags": [ "Product Export" ], "summary": "Search for the Product Export resources.", "description": "Available since: 6.1.0.0", "operationId": "searchProductExport", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductExport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-export/{id}": { "get": { "tags": [ "Product Export" ], "summary": "Detailed information about a Product Export resource.", "description": "Available since: 6.1.0.0", "operationId": "getProductExport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Export" ], "summary": "Delete a Product Export resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteProductExport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Export" ], "summary": "Partially update information about a Product Export resource.", "description": "Available since: 6.1.0.0", "operationId": "updateProductExport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Export resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductExport" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-export": { "post": { "tags": [ "Product Export" ], "summary": "Aggregate for the Product Export resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductExport", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductExport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-feature-set": { "get": { "tags": [ "Product Feature Set" ], "summary": "List with basic information of Product Feature Set resources.", "description": "Available since: 6.3.0.0", "operationId": "getProductFeatureSetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Feature Set resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-feature-set?limit=25" }, "last": { "example": "/product-feature-set?limit=25&page=11" }, "next": { "example": "/product-feature-set?limit=25&page=4" }, "prev": { "example": "/product-feature-set?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Feature Set" ], "summary": "Create a new Product Feature Set resources.", "description": "Available since: 6.3.0.0", "operationId": "createProductFeatureSet", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-feature-set": { "post": { "tags": [ "Product Feature Set" ], "summary": "Search for the Product Feature Set resources.", "description": "Available since: 6.3.0.0", "operationId": "searchProductFeatureSet", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-feature-set/{id}": { "get": { "tags": [ "Product Feature Set" ], "summary": "Detailed information about a Product Feature Set resource.", "description": "Available since: 6.3.0.0", "operationId": "getProductFeatureSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Feature Set" ], "summary": "Delete a Product Feature Set resource.", "description": "Available since: 6.3.0.0", "operationId": "deleteProductFeatureSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Feature Set" ], "summary": "Partially update information about a Product Feature Set resource.", "description": "Available since: 6.3.0.0", "operationId": "updateProductFeatureSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Feature Set resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-feature-set": { "post": { "tags": [ "Product Feature Set" ], "summary": "Aggregate for the Product Feature Set resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductFeatureSet", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-keyword-dictionary": { "get": { "tags": [ "Product Keyword Dictionary" ], "summary": "List with basic information of Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductKeywordDictionaryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Keyword Dictionary resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-keyword-dictionary?limit=25" }, "last": { "example": "/product-keyword-dictionary?limit=25&page=11" }, "next": { "example": "/product-keyword-dictionary?limit=25&page=4" }, "prev": { "example": "/product-keyword-dictionary?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Keyword Dictionary" ], "summary": "Create a new Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductKeywordDictionary", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-keyword-dictionary": { "post": { "tags": [ "Product Keyword Dictionary" ], "summary": "Search for the Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductKeywordDictionary", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-keyword-dictionary/{id}": { "get": { "tags": [ "Product Keyword Dictionary" ], "summary": "Detailed information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Keyword Dictionary" ], "summary": "Delete a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Keyword Dictionary" ], "summary": "Partially update information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Keyword Dictionary resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-keyword-dictionary": { "post": { "tags": [ "Product Keyword Dictionary" ], "summary": "Aggregate for the Product Keyword Dictionary resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductKeywordDictionary", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-manufacturer": { "get": { "tags": [ "Product Manufacturer" ], "summary": "List with basic information of Product Manufacturer resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductManufacturerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Manufacturer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-manufacturer?limit=25" }, "last": { "example": "/product-manufacturer?limit=25&page=11" }, "next": { "example": "/product-manufacturer?limit=25&page=4" }, "prev": { "example": "/product-manufacturer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Manufacturer" ], "summary": "Create a new Product Manufacturer resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductManufacturer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-manufacturer": { "post": { "tags": [ "Product Manufacturer" ], "summary": "Search for the Product Manufacturer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductManufacturer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-manufacturer/{id}": { "get": { "tags": [ "Product Manufacturer" ], "summary": "Detailed information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductManufacturer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Manufacturer" ], "summary": "Delete a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductManufacturer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Manufacturer" ], "summary": "Partially update information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductManufacturer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Manufacturer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-manufacturer": { "post": { "tags": [ "Product Manufacturer" ], "summary": "Aggregate for the Product Manufacturer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductManufacturer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-media": { "get": { "tags": [ "Product Media" ], "summary": "List with basic information of Product Media resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductMediaList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Media resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-media?limit=25" }, "last": { "example": "/product-media?limit=25&page=11" }, "next": { "example": "/product-media?limit=25&page=4" }, "prev": { "example": "/product-media?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Media" ], "summary": "Create a new Product Media resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductMedia", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-media": { "post": { "tags": [ "Product Media" ], "summary": "Search for the Product Media resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductMedia", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductMedia", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-media/{id}": { "get": { "tags": [ "Product Media" ], "summary": "Detailed information about a Product Media resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Media" ], "summary": "Delete a Product Media resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Media" ], "summary": "Partially update information about a Product Media resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Media resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductMedia" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-media": { "post": { "tags": [ "Product Media" ], "summary": "Aggregate for the Product Media resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductMedia", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductMedia", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-price": { "get": { "tags": [ "Product Price" ], "summary": "List with basic information of Product Price resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductPriceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Price resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-price?limit=25" }, "last": { "example": "/product-price?limit=25&page=11" }, "next": { "example": "/product-price?limit=25&page=4" }, "prev": { "example": "/product-price?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Price" ], "summary": "Create a new Product Price resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductPrice", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-price": { "post": { "tags": [ "Product Price" ], "summary": "Search for the Product Price resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductPrice", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-price/{id}": { "get": { "tags": [ "Product Price" ], "summary": "Detailed information about a Product Price resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Price" ], "summary": "Delete a Product Price resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Price" ], "summary": "Partially update information about a Product Price resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Price resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-price": { "post": { "tags": [ "Product Price" ], "summary": "Aggregate for the Product Price resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-review": { "get": { "tags": [ "Product Review" ], "summary": "List with basic information of Product Review resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductReviewList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Review resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-review?limit=25" }, "last": { "example": "/product-review?limit=25&page=11" }, "next": { "example": "/product-review?limit=25&page=4" }, "prev": { "example": "/product-review?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Review" ], "summary": "Create a new Product Review resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductReview", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-review": { "post": { "tags": [ "Product Review" ], "summary": "Search for the Product Review resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductReview", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductReview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-review/{id}": { "get": { "tags": [ "Product Review" ], "summary": "Detailed information about a Product Review resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductReview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Review" ], "summary": "Delete a Product Review resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductReview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Review" ], "summary": "Partially update information about a Product Review resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductReview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Review resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductReview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-review": { "post": { "tags": [ "Product Review" ], "summary": "Aggregate for the Product Review resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductReview", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductReview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-config": { "get": { "tags": [ "Product Search Config" ], "summary": "List with basic information of Product Search Config resources.", "description": "Available since: 6.3.5.0", "operationId": "getProductSearchConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Search Config resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-search-config?limit=25" }, "last": { "example": "/product-search-config?limit=25&page=11" }, "next": { "example": "/product-search-config?limit=25&page=4" }, "prev": { "example": "/product-search-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Search Config" ], "summary": "Create a new Product Search Config resources.", "description": "Available since: 6.3.5.0", "operationId": "createProductSearchConfig", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-search-config": { "post": { "tags": [ "Product Search Config" ], "summary": "Search for the Product Search Config resources.", "description": "Available since: 6.3.5.0", "operationId": "searchProductSearchConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-config/{id}": { "get": { "tags": [ "Product Search Config" ], "summary": "Detailed information about a Product Search Config resource.", "description": "Available since: 6.3.5.0", "operationId": "getProductSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Search Config" ], "summary": "Delete a Product Search Config resource.", "description": "Available since: 6.3.5.0", "operationId": "deleteProductSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Search Config" ], "summary": "Partially update information about a Product Search Config resource.", "description": "Available since: 6.3.5.0", "operationId": "updateProductSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Search Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-search-config": { "post": { "tags": [ "Product Search Config" ], "summary": "Aggregate for the Product Search Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductSearchConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-config-field": { "get": { "tags": [ "Product Search Config Field" ], "summary": "List with basic information of Product Search Config Field resources.", "description": "Available since: 6.3.5.0", "operationId": "getProductSearchConfigFieldList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Search Config Field resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-search-config-field?limit=25" }, "last": { "example": "/product-search-config-field?limit=25&page=11" }, "next": { "example": "/product-search-config-field?limit=25&page=4" }, "prev": { "example": "/product-search-config-field?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Search Config Field" ], "summary": "Create a new Product Search Config Field resources.", "description": "Available since: 6.3.5.0", "operationId": "createProductSearchConfigField", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-search-config-field": { "post": { "tags": [ "Product Search Config Field" ], "summary": "Search for the Product Search Config Field resources.", "description": "Available since: 6.3.5.0", "operationId": "searchProductSearchConfigField", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-config-field/{id}": { "get": { "tags": [ "Product Search Config Field" ], "summary": "Detailed information about a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", "operationId": "getProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Search Config Field" ], "summary": "Delete a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", "operationId": "deleteProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Search Config Field" ], "summary": "Partially update information about a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", "operationId": "updateProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Search Config Field resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-search-config-field": { "post": { "tags": [ "Product Search Config Field" ], "summary": "Aggregate for the Product Search Config Field resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductSearchConfigField", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-keyword": { "get": { "tags": [ "Product Search Keyword" ], "summary": "List with basic information of Product Search Keyword resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductSearchKeywordList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Search Keyword resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-search-keyword?limit=25" }, "last": { "example": "/product-search-keyword?limit=25&page=11" }, "next": { "example": "/product-search-keyword?limit=25&page=4" }, "prev": { "example": "/product-search-keyword?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Search Keyword" ], "summary": "Create a new Product Search Keyword resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductSearchKeyword", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-search-keyword": { "post": { "tags": [ "Product Search Keyword" ], "summary": "Search for the Product Search Keyword resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductSearchKeyword", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-search-keyword/{id}": { "get": { "tags": [ "Product Search Keyword" ], "summary": "Detailed information about a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Search Keyword" ], "summary": "Delete a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Search Keyword" ], "summary": "Partially update information about a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Search Keyword resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-search-keyword": { "post": { "tags": [ "Product Search Keyword" ], "summary": "Aggregate for the Product Search Keyword resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductSearchKeyword", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-sorting": { "get": { "tags": [ "Product Sorting" ], "summary": "List with basic information of Product Sorting resources.", "description": "Available since: 6.3.2.0", "operationId": "getProductSortingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Sorting resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-sorting?limit=25" }, "last": { "example": "/product-sorting?limit=25&page=11" }, "next": { "example": "/product-sorting?limit=25&page=4" }, "prev": { "example": "/product-sorting?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Sorting" ], "summary": "Create a new Product Sorting resources.", "description": "Available since: 6.3.2.0", "operationId": "createProductSorting", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-sorting": { "post": { "tags": [ "Product Sorting" ], "summary": "Search for the Product Sorting resources.", "description": "Available since: 6.3.2.0", "operationId": "searchProductSorting", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductSorting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-sorting/{id}": { "get": { "tags": [ "Product Sorting" ], "summary": "Detailed information about a Product Sorting resource.", "description": "Available since: 6.3.2.0", "operationId": "getProductSorting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Sorting" ], "summary": "Delete a Product Sorting resource.", "description": "Available since: 6.3.2.0", "operationId": "deleteProductSorting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Sorting" ], "summary": "Partially update information about a Product Sorting resource.", "description": "Available since: 6.3.2.0", "operationId": "updateProductSorting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Sorting resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductSorting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-sorting": { "post": { "tags": [ "Product Sorting" ], "summary": "Aggregate for the Product Sorting resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductSorting", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductSorting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSorting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-stream": { "get": { "tags": [ "Product Stream" ], "summary": "List with basic information of Product Stream resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductStreamList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Stream resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-stream?limit=25" }, "last": { "example": "/product-stream?limit=25&page=11" }, "next": { "example": "/product-stream?limit=25&page=4" }, "prev": { "example": "/product-stream?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Stream" ], "summary": "Create a new Product Stream resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductStream", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-stream": { "post": { "tags": [ "Product Stream" ], "summary": "Search for the Product Stream resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductStream", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-stream/{id}": { "get": { "tags": [ "Product Stream" ], "summary": "Detailed information about a Product Stream resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Stream" ], "summary": "Delete a Product Stream resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Stream" ], "summary": "Partially update information about a Product Stream resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Stream resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStream" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-stream": { "post": { "tags": [ "Product Stream" ], "summary": "Aggregate for the Product Stream resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductStream", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-stream-filter": { "get": { "tags": [ "Product Stream Filter" ], "summary": "List with basic information of Product Stream Filter resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductStreamFilterList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Stream Filter resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-stream-filter?limit=25" }, "last": { "example": "/product-stream-filter?limit=25&page=11" }, "next": { "example": "/product-stream-filter?limit=25&page=4" }, "prev": { "example": "/product-stream-filter?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Stream Filter" ], "summary": "Create a new Product Stream Filter resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductStreamFilter", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-stream-filter": { "post": { "tags": [ "Product Stream Filter" ], "summary": "Search for the Product Stream Filter resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductStreamFilter", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-stream-filter/{id}": { "get": { "tags": [ "Product Stream Filter" ], "summary": "Detailed information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Stream Filter" ], "summary": "Delete a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Stream Filter" ], "summary": "Partially update information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Stream Filter resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-stream-filter": { "post": { "tags": [ "Product Stream Filter" ], "summary": "Aggregate for the Product Stream Filter resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductStreamFilter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-visibility": { "get": { "tags": [ "Product Visibility" ], "summary": "List with basic information of Product Visibility resources.", "description": "Available since: 6.0.0.0", "operationId": "getProductVisibilityList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Visibility resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-visibility?limit=25" }, "last": { "example": "/product-visibility?limit=25&page=11" }, "next": { "example": "/product-visibility?limit=25&page=4" }, "prev": { "example": "/product-visibility?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Product Visibility" ], "summary": "Create a new Product Visibility resources.", "description": "Available since: 6.0.0.0", "operationId": "createProductVisibility", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-visibility": { "post": { "tags": [ "Product Visibility" ], "summary": "Search for the Product Visibility resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductVisibility", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-visibility/{id}": { "get": { "tags": [ "Product Visibility" ], "summary": "Detailed information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", "operationId": "getProductVisibility", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Product Visibility" ], "summary": "Delete a Product Visibility resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteProductVisibility", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Product Visibility" ], "summary": "Partially update information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", "operationId": "updateProductVisibility", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Visibility resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ProductVisibility" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/product-visibility": { "post": { "tags": [ "Product Visibility" ], "summary": "Aggregate for the Product Visibility resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductVisibility", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion": { "get": { "tags": [ "Promotion" ], "summary": "List with basic information of Promotion resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion?limit=25" }, "last": { "example": "/promotion?limit=25&page=11" }, "next": { "example": "/promotion?limit=25&page=4" }, "prev": { "example": "/promotion?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion" ], "summary": "Create a new Promotion resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotion", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion": { "post": { "tags": [ "Promotion" ], "summary": "Search for the Promotion resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotion", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Promotion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion/{id}": { "get": { "tags": [ "Promotion" ], "summary": "Detailed information about a Promotion resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion" ], "summary": "Delete a Promotion resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion" ], "summary": "Partially update information about a Promotion resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Promotion" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion": { "post": { "tags": [ "Promotion" ], "summary": "Aggregate for the Promotion resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotion", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Promotion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-discount": { "get": { "tags": [ "Promotion Discount" ], "summary": "List with basic information of Promotion Discount resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionDiscountList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion Discount resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion-discount?limit=25" }, "last": { "example": "/promotion-discount?limit=25&page=11" }, "next": { "example": "/promotion-discount?limit=25&page=4" }, "prev": { "example": "/promotion-discount?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion Discount" ], "summary": "Create a new Promotion Discount resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotionDiscount", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion-discount": { "post": { "tags": [ "Promotion Discount" ], "summary": "Search for the Promotion Discount resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionDiscount", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-discount/{id}": { "get": { "tags": [ "Promotion Discount" ], "summary": "Detailed information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionDiscount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion Discount" ], "summary": "Delete a Promotion Discount resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotionDiscount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion Discount" ], "summary": "Partially update information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotionDiscount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion Discount resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion-discount": { "post": { "tags": [ "Promotion Discount" ], "summary": "Aggregate for the Promotion Discount resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotionDiscount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-discount-prices": { "get": { "tags": [ "Promotion Discount Prices" ], "summary": "List with basic information of Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionDiscountPricesList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion Discount Prices resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion-discount-prices?limit=25" }, "last": { "example": "/promotion-discount-prices?limit=25&page=11" }, "next": { "example": "/promotion-discount-prices?limit=25&page=4" }, "prev": { "example": "/promotion-discount-prices?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion Discount Prices" ], "summary": "Create a new Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotionDiscountPrices", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion-discount-prices": { "post": { "tags": [ "Promotion Discount Prices" ], "summary": "Search for the Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionDiscountPrices", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-discount-prices/{id}": { "get": { "tags": [ "Promotion Discount Prices" ], "summary": "Detailed information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion Discount Prices" ], "summary": "Delete a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion Discount Prices" ], "summary": "Partially update information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion Discount Prices resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion-discount-prices": { "post": { "tags": [ "Promotion Discount Prices" ], "summary": "Aggregate for the Promotion Discount Prices resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotionDiscountPrices", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-individual-code": { "get": { "tags": [ "Promotion Individual Code" ], "summary": "List with basic information of Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionIndividualCodeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion Individual Code resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion-individual-code?limit=25" }, "last": { "example": "/promotion-individual-code?limit=25&page=11" }, "next": { "example": "/promotion-individual-code?limit=25&page=4" }, "prev": { "example": "/promotion-individual-code?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion Individual Code" ], "summary": "Create a new Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotionIndividualCode", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion-individual-code": { "post": { "tags": [ "Promotion Individual Code" ], "summary": "Search for the Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionIndividualCode", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-individual-code/{id}": { "get": { "tags": [ "Promotion Individual Code" ], "summary": "Detailed information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion Individual Code" ], "summary": "Delete a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion Individual Code" ], "summary": "Partially update information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion Individual Code resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion-individual-code": { "post": { "tags": [ "Promotion Individual Code" ], "summary": "Aggregate for the Promotion Individual Code resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotionIndividualCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-sales-channel": { "get": { "tags": [ "Promotion Sales Channel" ], "summary": "List with basic information of Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion-sales-channel?limit=25" }, "last": { "example": "/promotion-sales-channel?limit=25&page=11" }, "next": { "example": "/promotion-sales-channel?limit=25&page=4" }, "prev": { "example": "/promotion-sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion Sales Channel" ], "summary": "Create a new Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotionSalesChannel", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion-sales-channel": { "post": { "tags": [ "Promotion Sales Channel" ], "summary": "Search for the Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-sales-channel/{id}": { "get": { "tags": [ "Promotion Sales Channel" ], "summary": "Detailed information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion Sales Channel" ], "summary": "Delete a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion Sales Channel" ], "summary": "Partially update information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion-sales-channel": { "post": { "tags": [ "Promotion Sales Channel" ], "summary": "Aggregate for the Promotion Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotionSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-setgroup": { "get": { "tags": [ "Promotion Setgroup" ], "summary": "List with basic information of Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionSetgroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Promotion Setgroup resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/promotion-setgroup?limit=25" }, "last": { "example": "/promotion-setgroup?limit=25&page=11" }, "next": { "example": "/promotion-setgroup?limit=25&page=4" }, "prev": { "example": "/promotion-setgroup?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Promotion Setgroup" ], "summary": "Create a new Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", "operationId": "createPromotionSetgroup", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/promotion-setgroup": { "post": { "tags": [ "Promotion Setgroup" ], "summary": "Search for the Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionSetgroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/promotion-setgroup/{id}": { "get": { "tags": [ "Promotion Setgroup" ], "summary": "Detailed information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", "operationId": "getPromotionSetgroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Promotion Setgroup" ], "summary": "Delete a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Promotion Setgroup" ], "summary": "Partially update information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Promotion Setgroup resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/promotion-setgroup": { "post": { "tags": [ "Promotion Setgroup" ], "summary": "Aggregate for the Promotion Setgroup resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePromotionSetgroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/property-group": { "get": { "tags": [ "Property Group" ], "summary": "List with basic information of Property Group resources.", "description": "Available since: 6.0.0.0", "operationId": "getPropertyGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Property Group resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/property-group?limit=25" }, "last": { "example": "/property-group?limit=25&page=11" }, "next": { "example": "/property-group?limit=25&page=4" }, "prev": { "example": "/property-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Property Group" ], "summary": "Create a new Property Group resources.", "description": "Available since: 6.0.0.0", "operationId": "createPropertyGroup", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/property-group": { "post": { "tags": [ "Property Group" ], "summary": "Search for the Property Group resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPropertyGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/property-group/{id}": { "get": { "tags": [ "Property Group" ], "summary": "Detailed information about a Property Group resource.", "description": "Available since: 6.0.0.0", "operationId": "getPropertyGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Property Group" ], "summary": "Delete a Property Group resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePropertyGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Property Group" ], "summary": "Partially update information about a Property Group resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePropertyGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Property Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/property-group": { "post": { "tags": [ "Property Group" ], "summary": "Aggregate for the Property Group resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePropertyGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/property-group-option": { "get": { "tags": [ "Property Group Option" ], "summary": "List with basic information of Property Group Option resources.", "description": "Available since: 6.0.0.0", "operationId": "getPropertyGroupOptionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Property Group Option resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/property-group-option?limit=25" }, "last": { "example": "/property-group-option?limit=25&page=11" }, "next": { "example": "/property-group-option?limit=25&page=4" }, "prev": { "example": "/property-group-option?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Property Group Option" ], "summary": "Create a new Property Group Option resources.", "description": "Available since: 6.0.0.0", "operationId": "createPropertyGroupOption", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/property-group-option": { "post": { "tags": [ "Property Group Option" ], "summary": "Search for the Property Group Option resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPropertyGroupOption", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/property-group-option/{id}": { "get": { "tags": [ "Property Group Option" ], "summary": "Detailed information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", "operationId": "getPropertyGroupOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Property Group Option" ], "summary": "Delete a Property Group Option resource.", "description": "Available since: 6.0.0.0", "operationId": "deletePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Property Group Option" ], "summary": "Partially update information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", "operationId": "updatePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Property Group Option resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/property-group-option": { "post": { "tags": [ "Property Group Option" ], "summary": "Aggregate for the Property Group Option resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregatePropertyGroupOption", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/rule": { "get": { "tags": [ "Rule" ], "summary": "List with basic information of Rule resources.", "description": "Available since: 6.0.0.0", "operationId": "getRuleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Rule resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/rule?limit=25" }, "last": { "example": "/rule?limit=25&page=11" }, "next": { "example": "/rule?limit=25&page=4" }, "prev": { "example": "/rule?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Rule" ], "summary": "Create a new Rule resources.", "description": "Available since: 6.0.0.0", "operationId": "createRule", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/rule": { "post": { "tags": [ "Rule" ], "summary": "Search for the Rule resources.", "description": "Available since: 6.0.0.0", "operationId": "searchRule", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Rule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/rule/{id}": { "get": { "tags": [ "Rule" ], "summary": "Detailed information about a Rule resource.", "description": "Available since: 6.0.0.0", "operationId": "getRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Rule" ], "summary": "Delete a Rule resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Rule" ], "summary": "Partially update information about a Rule resource.", "description": "Available since: 6.0.0.0", "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Rule resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Rule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/rule": { "post": { "tags": [ "Rule" ], "summary": "Aggregate for the Rule resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateRule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Rule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/rule-condition": { "get": { "tags": [ "Rule Condition" ], "summary": "List with basic information of Rule Condition resources.", "description": "Available since: 6.0.0.0", "operationId": "getRuleConditionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Rule Condition resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/rule-condition?limit=25" }, "last": { "example": "/rule-condition?limit=25&page=11" }, "next": { "example": "/rule-condition?limit=25&page=4" }, "prev": { "example": "/rule-condition?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Rule Condition" ], "summary": "Create a new Rule Condition resources.", "description": "Available since: 6.0.0.0", "operationId": "createRuleCondition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/rule-condition": { "post": { "tags": [ "Rule Condition" ], "summary": "Search for the Rule Condition resources.", "description": "Available since: 6.0.0.0", "operationId": "searchRuleCondition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of RuleCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/rule-condition/{id}": { "get": { "tags": [ "Rule Condition" ], "summary": "Detailed information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", "operationId": "getRuleCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Rule Condition" ], "summary": "Delete a Rule Condition resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteRuleCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Rule Condition" ], "summary": "Partially update information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", "operationId": "updateRuleCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Rule Condition resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/RuleCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/rule-condition": { "post": { "tags": [ "Rule Condition" ], "summary": "Aggregate for the Rule Condition resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateRuleCondition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of RuleCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel": { "get": { "tags": [ "Sales Channel" ], "summary": "List with basic information of Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel?limit=25" }, "last": { "example": "/sales-channel?limit=25&page=11" }, "next": { "example": "/sales-channel?limit=25&page=4" }, "prev": { "example": "/sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel" ], "summary": "Create a new Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "createSalesChannel", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel": { "post": { "tags": [ "Sales Channel" ], "summary": "Search for the Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel/{id}": { "get": { "tags": [ "Sales Channel" ], "summary": "Detailed information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel" ], "summary": "Delete a Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel" ], "summary": "Partially update information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel": { "post": { "tags": [ "Sales Channel" ], "summary": "Aggregate for the Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-analytics": { "get": { "tags": [ "Sales Channel Analytics" ], "summary": "List with basic information of Sales Channel Analytics resources.", "description": "Available since: 6.2.0.0", "operationId": "getSalesChannelAnalyticsList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel Analytics resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel-analytics?limit=25" }, "last": { "example": "/sales-channel-analytics?limit=25&page=11" }, "next": { "example": "/sales-channel-analytics?limit=25&page=4" }, "prev": { "example": "/sales-channel-analytics?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel Analytics" ], "summary": "Create a new Sales Channel Analytics resources.", "description": "Available since: 6.2.0.0", "operationId": "createSalesChannelAnalytics", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel-analytics": { "post": { "tags": [ "Sales Channel Analytics" ], "summary": "Search for the Sales Channel Analytics resources.", "description": "Available since: 6.2.0.0", "operationId": "searchSalesChannelAnalytics", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-analytics/{id}": { "get": { "tags": [ "Sales Channel Analytics" ], "summary": "Detailed information about a Sales Channel Analytics resource.", "description": "Available since: 6.2.0.0", "operationId": "getSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel Analytics" ], "summary": "Delete a Sales Channel Analytics resource.", "description": "Available since: 6.2.0.0", "operationId": "deleteSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel Analytics" ], "summary": "Partially update information about a Sales Channel Analytics resource.", "description": "Available since: 6.2.0.0", "operationId": "updateSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel Analytics resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel-analytics": { "post": { "tags": [ "Sales Channel Analytics" ], "summary": "Aggregate for the Sales Channel Analytics resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalesChannelAnalytics", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelAnalytics" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-domain": { "get": { "tags": [ "Sales Channel Domain" ], "summary": "List with basic information of Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannelDomainList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel Domain resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel-domain?limit=25" }, "last": { "example": "/sales-channel-domain?limit=25&page=11" }, "next": { "example": "/sales-channel-domain?limit=25&page=4" }, "prev": { "example": "/sales-channel-domain?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel Domain" ], "summary": "Create a new Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", "operationId": "createSalesChannelDomain", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel-domain": { "post": { "tags": [ "Sales Channel Domain" ], "summary": "Search for the Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannelDomain", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-domain/{id}": { "get": { "tags": [ "Sales Channel Domain" ], "summary": "Detailed information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel Domain" ], "summary": "Delete a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel Domain" ], "summary": "Partially update information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel Domain resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel-domain": { "post": { "tags": [ "Sales Channel Domain" ], "summary": "Aggregate for the Sales Channel Domain resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalesChannelDomain", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-tracking-customer": { "get": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel Tracking Customer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel-tracking-customer?limit=25" }, "last": { "example": "/sales-channel-tracking-customer?limit=25&page=11" }, "next": { "example": "/sales-channel-tracking-customer?limit=25&page=4" }, "prev": { "example": "/sales-channel-tracking-customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel-tracking-customer": { "post": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel Tracking Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel-tracking-customer": { "post": { "tags": [ "Sales Channel Tracking Customer", "Experimental" ], "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "aggregateSalesChannelTrackingCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-tracking-order": { "get": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "getSalesChannelTrackingOrderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel Tracking Order resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel-tracking-order?limit=25" }, "last": { "example": "/sales-channel-tracking-order?limit=25&page=11" }, "next": { "example": "/sales-channel-tracking-order?limit=25&page=4" }, "prev": { "example": "/sales-channel-tracking-order?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "createSalesChannelTrackingOrder", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel-tracking-order": { "post": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-tracking-order/{id}": { "get": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "getSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel Tracking Order resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel-tracking-order": { "post": { "tags": [ "Sales Channel Tracking Order", "Experimental" ], "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-type": { "get": { "tags": [ "Sales Channel Type" ], "summary": "List with basic information of Sales Channel Type resources.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sales-channel-type?limit=25" }, "last": { "example": "/sales-channel-type?limit=25&page=11" }, "next": { "example": "/sales-channel-type?limit=25&page=4" }, "prev": { "example": "/sales-channel-type?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Sales Channel Type" ], "summary": "Create a new Sales Channel Type resources.", "description": "Available since: 6.0.0.0", "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sales-channel-type": { "post": { "tags": [ "Sales Channel Type" ], "summary": "Search for the Sales Channel Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannelType", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-type/{id}": { "get": { "tags": [ "Sales Channel Type" ], "summary": "Detailed information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Sales Channel Type" ], "summary": "Delete a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Sales Channel Type" ], "summary": "Partially update information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SalesChannelType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/sales-channel-type": { "post": { "tags": [ "Sales Channel Type" ], "summary": "Aggregate for the Sales Channel Type resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalesChannelType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/salutation": { "get": { "tags": [ "Salutation" ], "summary": "List with basic information of Salutation resources.", "description": "Available since: 6.0.0.0", "operationId": "getSalutationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/salutation?limit=25" }, "last": { "example": "/salutation?limit=25&page=11" }, "next": { "example": "/salutation?limit=25&page=4" }, "prev": { "example": "/salutation?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Salutation" ], "summary": "Fetches salutations with a criteria obj.", "description": "Fetches salutations with a criteria obj.", "operationId": "createSalutation", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/salutation": { "post": { "tags": [ "Salutation" ], "summary": "Search for the Salutation resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalutation", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/salutation/{id}": { "get": { "tags": [ "Salutation" ], "summary": "Detailed information about a Salutation resource.", "description": "Available since: 6.0.0.0", "operationId": "getSalutation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Salutation" ], "summary": "Delete a Salutation resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Salutation" ], "summary": "Partially update information about a Salutation resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSalutation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Salutation resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Salutation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/salutation": { "post": { "tags": [ "Salutation" ], "summary": "Aggregate for the Salutation resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalutation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Salutation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/scheduled-task": { "get": { "tags": [ "Scheduled Task" ], "summary": "List with basic information of Scheduled Task resources.", "description": "Available since: 6.0.0.0", "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/scheduled-task?limit=25" }, "last": { "example": "/scheduled-task?limit=25&page=11" }, "next": { "example": "/scheduled-task?limit=25&page=4" }, "prev": { "example": "/scheduled-task?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Scheduled Task" ], "summary": "Create a new Scheduled Task resources.", "description": "Available since: 6.0.0.0", "operationId": "createScheduledTask", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/scheduled-task": { "post": { "tags": [ "Scheduled Task" ], "summary": "Search for the Scheduled Task resources.", "description": "Available since: 6.0.0.0", "operationId": "searchScheduledTask", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/scheduled-task/{id}": { "get": { "tags": [ "Scheduled Task" ], "summary": "Detailed information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Scheduled Task" ], "summary": "Delete a Scheduled Task resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Scheduled Task" ], "summary": "Partially update information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Scheduled Task resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ScheduledTask" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/scheduled-task": { "post": { "tags": [ "Scheduled Task" ], "summary": "Aggregate for the Scheduled Task resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateScheduledTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledTask" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/script": { "get": { "tags": [ "Script" ], "summary": "List with basic information of Script resources.", "description": "Available since: 6.4.7.0", "operationId": "getScriptList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/script?limit=25" }, "last": { "example": "/script?limit=25&page=11" }, "next": { "example": "/script?limit=25&page=4" }, "prev": { "example": "/script?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Script" ], "summary": "Create a new Script resources.", "description": "Available since: 6.4.7.0", "operationId": "createScript", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Script" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Script" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/script": { "post": { "tags": [ "Script" ], "summary": "Search for the Script resources.", "description": "Available since: 6.4.7.0", "operationId": "searchScript", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/script/{id}": { "get": { "tags": [ "Script" ], "summary": "Detailed information about a Script resource.", "description": "Available since: 6.4.7.0", "operationId": "getScript", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the script", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Script" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Script" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Script" ], "summary": "Delete a Script resource.", "description": "Available since: 6.4.7.0", "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the script", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Script" ], "summary": "Partially update information about a Script resource.", "description": "Available since: 6.4.7.0", "operationId": "updateScript", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the script", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Script resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Script" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Script" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/script": { "post": { "tags": [ "Script" ], "summary": "Aggregate for the Script resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateScript", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/seo-url": { "get": { "tags": [ "Seo Url" ], "summary": "List with basic information of Seo Url resources.", "description": "Available since: 6.0.0.0", "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/seo-url?limit=25" }, "last": { "example": "/seo-url?limit=25&page=11" }, "next": { "example": "/seo-url?limit=25&page=4" }, "prev": { "example": "/seo-url?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Seo Url" ], "summary": "Create a new Seo Url resources.", "description": "Available since: 6.0.0.0", "operationId": "createSeoUrl", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/seo-url": { "post": { "tags": [ "Seo Url" ], "summary": "Search for the Seo Url resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSeoUrl", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/seo-url/{id}": { "get": { "tags": [ "Seo Url" ], "summary": "Detailed information about a Seo Url resource.", "description": "Available since: 6.0.0.0", "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Seo Url" ], "summary": "Delete a Seo Url resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Seo Url" ], "summary": "Partially update information about a Seo Url resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Seo Url resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrl" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/seo-url": { "post": { "tags": [ "Seo Url" ], "summary": "Aggregate for the Seo Url resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSeoUrl", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/seo-url-template": { "get": { "tags": [ "Seo Url Template" ], "summary": "List with basic information of Seo Url Template resources.", "description": "Available since: 6.0.0.0", "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/seo-url-template?limit=25" }, "last": { "example": "/seo-url-template?limit=25&page=11" }, "next": { "example": "/seo-url-template?limit=25&page=4" }, "prev": { "example": "/seo-url-template?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Seo Url Template" ], "summary": "Create a new Seo Url Template resources.", "description": "Available since: 6.0.0.0", "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/seo-url-template": { "post": { "tags": [ "Seo Url Template" ], "summary": "Search for the Seo Url Template resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSeoUrlTemplate", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/seo-url-template/{id}": { "get": { "tags": [ "Seo Url Template" ], "summary": "Detailed information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Seo Url Template" ], "summary": "Delete a Seo Url Template resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Seo Url Template" ], "summary": "Partially update information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Seo Url Template resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/seo-url-template": { "post": { "tags": [ "Seo Url Template" ], "summary": "Aggregate for the Seo Url Template resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSeoUrlTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/shipping-method": { "get": { "tags": [ "Shipping Method" ], "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/shipping-method?limit=25" }, "last": { "example": "/shipping-method?limit=25&page=11" }, "next": { "example": "/shipping-method?limit=25&page=4" }, "prev": { "example": "/shipping-method?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Shipping Method" ], "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", "operationId": "createShippingMethod", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/shipping-method": { "post": { "tags": [ "Shipping Method" ], "summary": "Search for the Shipping Method resources.", "description": "Available since: 6.0.0.0", "operationId": "searchShippingMethod", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/shipping-method/{id}": { "get": { "tags": [ "Shipping Method" ], "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Shipping Method" ], "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Shipping Method" ], "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Shipping Method resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethod" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/shipping-method": { "post": { "tags": [ "Shipping Method" ], "summary": "Aggregate for the Shipping Method resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateShippingMethod", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/shipping-method-price": { "get": { "tags": [ "Shipping Method Price" ], "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/shipping-method-price?limit=25" }, "last": { "example": "/shipping-method-price?limit=25&page=11" }, "next": { "example": "/shipping-method-price?limit=25&page=4" }, "prev": { "example": "/shipping-method-price?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Shipping Method Price" ], "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/shipping-method-price": { "post": { "tags": [ "Shipping Method Price" ], "summary": "Search for the Shipping Method Price resources.", "description": "Available since: 6.0.0.0", "operationId": "searchShippingMethodPrice", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/shipping-method-price/{id}": { "get": { "tags": [ "Shipping Method Price" ], "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Shipping Method Price" ], "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Shipping Method Price" ], "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/shipping-method-price": { "post": { "tags": [ "Shipping Method Price" ], "summary": "Aggregate for the Shipping Method Price resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateShippingMethodPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/snippet": { "get": { "tags": [ "Snippet" ], "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", "operationId": "getSnippetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/snippet?limit=25" }, "last": { "example": "/snippet?limit=25&page=11" }, "next": { "example": "/snippet?limit=25&page=4" }, "prev": { "example": "/snippet?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Snippet" ], "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", "operationId": "createSnippet", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/snippet": { "post": { "tags": [ "Snippet" ], "summary": "Search for the Snippet resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSnippet", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/snippet/{id}": { "get": { "tags": [ "Snippet" ], "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Snippet" ], "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Snippet" ], "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Snippet resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Snippet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/snippet": { "post": { "tags": [ "Snippet" ], "summary": "Aggregate for the Snippet resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSnippet", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/snippet-set": { "get": { "tags": [ "Snippet Set" ], "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/snippet-set?limit=25" }, "last": { "example": "/snippet-set?limit=25&page=11" }, "next": { "example": "/snippet-set?limit=25&page=4" }, "prev": { "example": "/snippet-set?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Snippet Set" ], "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", "operationId": "createSnippetSet", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/snippet-set": { "post": { "tags": [ "Snippet Set" ], "summary": "Search for the Snippet Set resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSnippetSet", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/snippet-set/{id}": { "get": { "tags": [ "Snippet Set" ], "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Snippet Set" ], "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Snippet Set" ], "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Snippet Set resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SnippetSet" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/snippet-set": { "post": { "tags": [ "Snippet Set" ], "summary": "Aggregate for the Snippet Set resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSnippetSet", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetSet" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine": { "get": { "tags": [ "State Machine" ], "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/state-machine?limit=25" }, "last": { "example": "/state-machine?limit=25&page=11" }, "next": { "example": "/state-machine?limit=25&page=4" }, "prev": { "example": "/state-machine?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "State Machine" ], "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", "operationId": "createStateMachine", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/state-machine": { "post": { "tags": [ "State Machine" ], "summary": "Search for the State Machine resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachine", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine/{id}": { "get": { "tags": [ "State Machine" ], "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "State Machine" ], "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "State Machine" ], "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a State Machine resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachine" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/state-machine": { "post": { "tags": [ "State Machine" ], "summary": "Aggregate for the State Machine resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateStateMachine", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachine" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-history": { "get": { "tags": [ "State Machine History" ], "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/state-machine-history?limit=25" }, "last": { "example": "/state-machine-history?limit=25&page=11" }, "next": { "example": "/state-machine-history?limit=25&page=4" }, "prev": { "example": "/state-machine-history?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "State Machine History" ], "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/state-machine-history": { "post": { "tags": [ "State Machine History" ], "summary": "Search for the State Machine History resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineHistory", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-history/{id}": { "get": { "tags": [ "State Machine History" ], "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "State Machine History" ], "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "State Machine History" ], "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a State Machine History resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/state-machine-history": { "post": { "tags": [ "State Machine History" ], "summary": "Aggregate for the State Machine History resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateStateMachineHistory", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-state": { "get": { "tags": [ "State Machine State" ], "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/state-machine-state?limit=25" }, "last": { "example": "/state-machine-state?limit=25&page=11" }, "next": { "example": "/state-machine-state?limit=25&page=4" }, "prev": { "example": "/state-machine-state?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "State Machine State" ], "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", "operationId": "createStateMachineState", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/state-machine-state": { "post": { "tags": [ "State Machine State" ], "summary": "Search for the State Machine State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineState", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-state/{id}": { "get": { "tags": [ "State Machine State" ], "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "State Machine State" ], "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "State Machine State" ], "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a State Machine State resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineState" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/state-machine-state": { "post": { "tags": [ "State Machine State" ], "summary": "Aggregate for the State Machine State resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateStateMachineState", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-transition": { "get": { "tags": [ "State Machine Transition" ], "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/state-machine-transition?limit=25" }, "last": { "example": "/state-machine-transition?limit=25&page=11" }, "next": { "example": "/state-machine-transition?limit=25&page=4" }, "prev": { "example": "/state-machine-transition?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "State Machine Transition" ], "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/state-machine-transition": { "post": { "tags": [ "State Machine Transition" ], "summary": "Search for the State Machine Transition resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineTransition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/state-machine-transition/{id}": { "get": { "tags": [ "State Machine Transition" ], "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "State Machine Transition" ], "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "State Machine Transition" ], "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a State Machine Transition resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/state-machine-transition": { "post": { "tags": [ "State Machine Transition" ], "summary": "Aggregate for the State Machine Transition resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateStateMachineTransition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/system-config": { "get": { "tags": [ "System Config" ], "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/system-config?limit=25" }, "last": { "example": "/system-config?limit=25&page=11" }, "next": { "example": "/system-config?limit=25&page=4" }, "prev": { "example": "/system-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "System Config" ], "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", "operationId": "createSystemConfig", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/system-config": { "post": { "tags": [ "System Config" ], "summary": "Search for the System Config resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSystemConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/system-config/{id}": { "get": { "tags": [ "System Config" ], "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "System Config" ], "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "System Config" ], "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a System Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SystemConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/system-config": { "post": { "tags": [ "System Config" ], "summary": "Aggregate for the System Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSystemConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tag": { "get": { "tags": [ "Tag" ], "summary": "List with basic information of Tag resources.", "description": "Available since: 6.0.0.0", "operationId": "getTagList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/tag?limit=25" }, "last": { "example": "/tag?limit=25&page=11" }, "next": { "example": "/tag?limit=25&page=4" }, "prev": { "example": "/tag?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Tag" ], "summary": "Create a new Tag resources.", "description": "Available since: 6.0.0.0", "operationId": "createTag", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/tag": { "post": { "tags": [ "Tag" ], "summary": "Search for the Tag resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTag", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tag/{id}": { "get": { "tags": [ "Tag" ], "summary": "Detailed information about a Tag resource.", "description": "Available since: 6.0.0.0", "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Tag" ], "summary": "Delete a Tag resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Tag" ], "summary": "Partially update information about a Tag resource.", "description": "Available since: 6.0.0.0", "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Tag resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/tag": { "post": { "tags": [ "Tag" ], "summary": "Aggregate for the Tag resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTag", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax": { "get": { "tags": [ "Tax" ], "summary": "List with basic information of Tax resources.", "description": "Available since: 6.0.0.0", "operationId": "getTaxList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/tax?limit=25" }, "last": { "example": "/tax?limit=25&page=11" }, "next": { "example": "/tax?limit=25&page=4" }, "prev": { "example": "/tax?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Tax" ], "summary": "Create a new Tax resources.", "description": "Available since: 6.0.0.0", "operationId": "createTax", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/tax": { "post": { "tags": [ "Tax" ], "summary": "Search for the Tax resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTax", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax/{id}": { "get": { "tags": [ "Tax" ], "summary": "Detailed information about a Tax resource.", "description": "Available since: 6.0.0.0", "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Tax" ], "summary": "Delete a Tax resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Tax" ], "summary": "Partially update information about a Tax resource.", "description": "Available since: 6.0.0.0", "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Tax resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Tax" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/tax": { "post": { "tags": [ "Tax" ], "summary": "Aggregate for the Tax resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTax", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-provider": { "get": { "tags": [ "Tax Provider" ], "summary": "List with basic information of Tax Provider resources.", "description": "Available since: 6.5.0.0", "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/tax-provider?limit=25" }, "last": { "example": "/tax-provider?limit=25&page=11" }, "next": { "example": "/tax-provider?limit=25&page=4" }, "prev": { "example": "/tax-provider?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Tax Provider" ], "summary": "Create a new Tax Provider resources.", "description": "Available since: 6.5.0.0", "operationId": "createTaxProvider", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/tax-provider": { "post": { "tags": [ "Tax Provider" ], "summary": "Search for the Tax Provider resources.", "description": "Available since: 6.5.0.0", "operationId": "searchTaxProvider", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-provider/{id}": { "get": { "tags": [ "Tax Provider" ], "summary": "Detailed information about a Tax Provider resource.", "description": "Available since: 6.5.0.0", "operationId": "getTaxProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Tax Provider" ], "summary": "Delete a Tax Provider resource.", "description": "Available since: 6.5.0.0", "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Tax Provider" ], "summary": "Partially update information about a Tax Provider resource.", "description": "Available since: 6.5.0.0", "operationId": "updateTaxProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Tax Provider resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxProvider" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/tax-provider": { "post": { "tags": [ "Tax Provider" ], "summary": "Aggregate for the Tax Provider resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTaxProvider", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-rule": { "get": { "tags": [ "Tax Rule" ], "summary": "List with basic information of Tax Rule resources.", "description": "Available since: 6.1.0.0", "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/tax-rule?limit=25" }, "last": { "example": "/tax-rule?limit=25&page=11" }, "next": { "example": "/tax-rule?limit=25&page=4" }, "prev": { "example": "/tax-rule?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Tax Rule" ], "summary": "Create a new Tax Rule resources.", "description": "Available since: 6.1.0.0", "operationId": "createTaxRule", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/tax-rule": { "post": { "tags": [ "Tax Rule" ], "summary": "Search for the Tax Rule resources.", "description": "Available since: 6.1.0.0", "operationId": "searchTaxRule", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-rule/{id}": { "get": { "tags": [ "Tax Rule" ], "summary": "Detailed information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", "operationId": "getTaxRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Tax Rule" ], "summary": "Delete a Tax Rule resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteTaxRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Tax Rule" ], "summary": "Partially update information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", "operationId": "updateTaxRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Tax Rule resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/tax-rule": { "post": { "tags": [ "Tax Rule" ], "summary": "Aggregate for the Tax Rule resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTaxRule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-rule-type": { "get": { "tags": [ "Tax Rule Type" ], "summary": "List with basic information of Tax Rule Type resources.", "description": "Available since: 6.1.0.0", "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/tax-rule-type?limit=25" }, "last": { "example": "/tax-rule-type?limit=25&page=11" }, "next": { "example": "/tax-rule-type?limit=25&page=4" }, "prev": { "example": "/tax-rule-type?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Tax Rule Type" ], "summary": "Create a new Tax Rule Type resources.", "description": "Available since: 6.1.0.0", "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/tax-rule-type": { "post": { "tags": [ "Tax Rule Type" ], "summary": "Search for the Tax Rule Type resources.", "description": "Available since: 6.1.0.0", "operationId": "searchTaxRuleType", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tax-rule-type/{id}": { "get": { "tags": [ "Tax Rule Type" ], "summary": "Detailed information about a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", "operationId": "getTaxRuleType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Tax Rule Type" ], "summary": "Delete a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", "operationId": "deleteTaxRuleType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Tax Rule Type" ], "summary": "Partially update information about a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", "operationId": "updateTaxRuleType", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TaxRuleType" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/tax-rule-type": { "post": { "tags": [ "Tax Rule Type" ], "summary": "Aggregate for the Tax Rule Type resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTaxRuleType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRuleType" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/theme": { "get": { "tags": [ "Theme" ], "summary": "List with basic information of Theme resources.", "description": "Available since: 6.0.0.0", "operationId": "getThemeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/theme?limit=25" }, "last": { "example": "/theme?limit=25&page=11" }, "next": { "example": "/theme?limit=25&page=4" }, "prev": { "example": "/theme?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Theme" ], "summary": "Create a new Theme resources.", "description": "Available since: 6.0.0.0", "operationId": "createTheme", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/theme": { "post": { "tags": [ "Theme" ], "summary": "Search for the Theme resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTheme", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/theme/{id}": { "get": { "tags": [ "Theme" ], "summary": "Detailed information about a Theme resource.", "description": "Available since: 6.0.0.0", "operationId": "getTheme", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the theme", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Theme" ], "summary": "Delete a Theme resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteTheme", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the theme", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Theme" ], "summary": "Partially update information about a Theme resource.", "description": "Available since: 6.0.0.0", "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the theme", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Theme resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Theme" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/theme": { "post": { "tags": [ "Theme" ], "summary": "Aggregate for the Theme resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/unit": { "get": { "tags": [ "Unit" ], "summary": "List with basic information of Unit resources.", "description": "Available since: 6.0.0.0", "operationId": "getUnitList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/unit?limit=25" }, "last": { "example": "/unit?limit=25&page=11" }, "next": { "example": "/unit?limit=25&page=4" }, "prev": { "example": "/unit?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Unit" ], "summary": "Create a new Unit resources.", "description": "Available since: 6.0.0.0", "operationId": "createUnit", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/unit": { "post": { "tags": [ "Unit" ], "summary": "Search for the Unit resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUnit", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/unit/{id}": { "get": { "tags": [ "Unit" ], "summary": "Detailed information about a Unit resource.", "description": "Available since: 6.0.0.0", "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Unit" ], "summary": "Delete a Unit resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Unit" ], "summary": "Partially update information about a Unit resource.", "description": "Available since: 6.0.0.0", "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the unit", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Unit resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Unit" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/unit": { "post": { "tags": [ "Unit" ], "summary": "Aggregate for the Unit resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateUnit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user": { "get": { "tags": [ "User" ], "summary": "List with basic information of User resources.", "description": "Available since: 6.0.0.0", "operationId": "getUserList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/User" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/user?limit=25" }, "last": { "example": "/user?limit=25&page=11" }, "next": { "example": "/user?limit=25&page=4" }, "prev": { "example": "/user?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "User" ], "summary": "Create a new User resources.", "description": "Available since: 6.0.0.0", "operationId": "createUser", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/User" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/user": { "post": { "tags": [ "User" ], "summary": "Search for the User resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUser", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of User", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user/{id}": { "get": { "tags": [ "User" ], "summary": "Detailed information about a User resource.", "description": "Available since: 6.0.0.0", "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/User" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "User" ], "summary": "Delete a User resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "User" ], "summary": "Partially update information about a User resource.", "description": "Available since: 6.0.0.0", "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a User resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/User" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/user": { "post": { "tags": [ "User" ], "summary": "Aggregate for the User resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateUser", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of User", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-access-key": { "get": { "tags": [ "User Access Key" ], "summary": "List with basic information of User Access Key resources.", "description": "Available since: 6.0.0.0", "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/user-access-key?limit=25" }, "last": { "example": "/user-access-key?limit=25&page=11" }, "next": { "example": "/user-access-key?limit=25&page=4" }, "prev": { "example": "/user-access-key?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "User Access Key" ], "summary": "Create a new User Access Key resources.", "description": "Available since: 6.0.0.0", "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/user-access-key": { "post": { "tags": [ "User Access Key" ], "summary": "Search for the User Access Key resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUserAccessKey", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-access-key/{id}": { "get": { "tags": [ "User Access Key" ], "summary": "Detailed information about a User Access Key resource.", "description": "Available since: 6.0.0.0", "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "User Access Key" ], "summary": "Delete a User Access Key resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "User Access Key" ], "summary": "Partially update information about a User Access Key resource.", "description": "Available since: 6.0.0.0", "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a User Access Key resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserAccessKey" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/user-access-key": { "post": { "tags": [ "User Access Key" ], "summary": "Aggregate for the User Access Key resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateUserAccessKey", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-config": { "get": { "tags": [ "User Config" ], "summary": "List with basic information of User Config resources.", "description": "Available since: 6.3.5.0", "operationId": "getUserConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/user-config?limit=25" }, "last": { "example": "/user-config?limit=25&page=11" }, "next": { "example": "/user-config?limit=25&page=4" }, "prev": { "example": "/user-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "User Config" ], "summary": "Create a new User Config resources.", "description": "Available since: 6.3.5.0", "operationId": "createUserConfig", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/user-config": { "post": { "tags": [ "User Config" ], "summary": "Search for the User Config resources.", "description": "Available since: 6.3.5.0", "operationId": "searchUserConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-config/{id}": { "get": { "tags": [ "User Config" ], "summary": "Detailed information about a User Config resource.", "description": "Available since: 6.3.5.0", "operationId": "getUserConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "User Config" ], "summary": "Delete a User Config resource.", "description": "Available since: 6.3.5.0", "operationId": "deleteUserConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "User Config" ], "summary": "Partially update information about a User Config resource.", "description": "Available since: 6.3.5.0", "operationId": "updateUserConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a User Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/user-config": { "post": { "tags": [ "User Config" ], "summary": "Aggregate for the User Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateUserConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-recovery": { "get": { "tags": [ "User Recovery" ], "summary": "List with basic information of User Recovery resources.", "description": "Available since: 6.0.0.0", "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/user-recovery?limit=25" }, "last": { "example": "/user-recovery?limit=25&page=11" }, "next": { "example": "/user-recovery?limit=25&page=4" }, "prev": { "example": "/user-recovery?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "User Recovery" ], "summary": "Create a new User Recovery resources.", "description": "Available since: 6.0.0.0", "operationId": "createUserRecovery", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/user-recovery": { "post": { "tags": [ "User Recovery" ], "summary": "Search for the User Recovery resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUserRecovery", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/user-recovery/{id}": { "get": { "tags": [ "User Recovery" ], "summary": "Detailed information about a User Recovery resource.", "description": "Available since: 6.0.0.0", "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "User Recovery" ], "summary": "Delete a User Recovery resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "User Recovery" ], "summary": "Partially update information about a User Recovery resource.", "description": "Available since: 6.0.0.0", "operationId": "updateUserRecovery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a User Recovery resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserRecovery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/user-recovery": { "post": { "tags": [ "User Recovery" ], "summary": "Aggregate for the User Recovery resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateUserRecovery", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecovery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/webhook": { "get": { "tags": [ "Webhook" ], "summary": "List with basic information of Webhook resources.", "description": "Available since: 6.3.1.0", "operationId": "getWebhookList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Webhook resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/webhook?limit=25" }, "last": { "example": "/webhook?limit=25&page=11" }, "next": { "example": "/webhook?limit=25&page=4" }, "prev": { "example": "/webhook?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Webhook" ], "summary": "Create a new Webhook resources.", "description": "Available since: 6.3.1.0", "operationId": "createWebhook", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/webhook": { "post": { "tags": [ "Webhook" ], "summary": "Search for the Webhook resources.", "description": "Available since: 6.3.1.0", "operationId": "searchWebhook", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/webhook/{id}": { "get": { "tags": [ "Webhook" ], "summary": "Detailed information about a Webhook resource.", "description": "Available since: 6.3.1.0", "operationId": "getWebhook", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Webhook" ], "summary": "Delete a Webhook resource.", "description": "Available since: 6.3.1.0", "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Webhook" ], "summary": "Partially update information about a Webhook resource.", "description": "Available since: 6.3.1.0", "operationId": "updateWebhook", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Webhook resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/webhook": { "post": { "tags": [ "Webhook" ], "summary": "Aggregate for the Webhook resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateWebhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/webhook-event-log": { "get": { "tags": [ "Webhook Event Log" ], "summary": "List with basic information of Webhook Event Log resources.", "description": "Available since: 6.4.1.0", "operationId": "getWebhookEventLogList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Webhook Event Log resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/webhook-event-log?limit=25" }, "last": { "example": "/webhook-event-log?limit=25&page=11" }, "next": { "example": "/webhook-event-log?limit=25&page=4" }, "prev": { "example": "/webhook-event-log?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "Webhook Event Log" ], "summary": "Create a new Webhook Event Log resources.", "description": "Available since: 6.4.1.0", "operationId": "createWebhookEventLog", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": [ "basic", "detail" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventLog" } } } }, "responses": { "200": { "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/webhook-event-log": { "post": { "tags": [ "Webhook Event Log" ], "summary": "Search for the Webhook Event Log resources.", "description": "Available since: 6.4.1.0", "operationId": "searchWebhookEventLog", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": [ "0", "1" ], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/webhook-event-log/{id}": { "get": { "tags": [ "Webhook Event Log" ], "summary": "Detailed information about a Webhook Event Log resource.", "description": "Available since: 6.4.1.0", "operationId": "getWebhookEventLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "Webhook Event Log" ], "summary": "Delete a Webhook Event Log resource.", "description": "Available since: 6.4.1.0", "operationId": "deleteWebhookEventLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "Webhook Event Log" ], "summary": "Partially update information about a Webhook Event Log resource.", "description": "Available since: 6.4.1.0", "operationId": "updateWebhookEventLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Webhook Event Log resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventLog" } } } }, "responses": { "200": { "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } } }, "/aggregate/webhook-event-log": { "post": { "tags": [ "Webhook Event Log" ], "summary": "Aggregate for the Webhook Event Log resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateWebhookEventLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": [ "aggregations" ] } } } }, "responses": { "200": { "description": "List of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/_info/flow-actions.json": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get actions for flow builder", "description": "Get a list of action for flow builder.", "operationId": "flow-actions", "responses": { "200": { "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } } } } }, "/oauth/token": { "post": { "tags": [ "Authorization & Authentication" ], "summary": "Fetch an access token", "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", "operationId": "token", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OAuthPasswordGrant" }, { "$ref": "#/components/schemas/OAuthRefreshTokenGrant" }, { "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } ] } } } }, "responses": { "200": { "description": "Authorized successfully.", "content": { "application/json": { "schema": { "required": [ "token_type", "expires_in", "access_token" ], "properties": { "token_type": { "description": "Type of the token.", "type": "string" }, "expires_in": { "description": "Token lifetime in seconds.", "type": "integer" }, "access_token": { "description": "The access token that can be used for subsequent requests", "type": "string" }, "refresh_token": { "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" } } } }, "/oauth/sso/config": { "get": { "tags": [ "Experimental", "SSO Login configuration" ], "summary": "Experimental: Loads SSO login configuration.", "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", "responses": { "200": { "description": "Experimental: Returns the configuration for the SSO login page forward.", "content": { "application/json": { "schema": { "type": "object", "properties": { "useDefault": { "description": "Experimental: Indicates which login is used. Default or SSO.", "type": "boolean" }, "url": { "description": "Experimental: Contains the return url for the Shopware SSO login.", "type": "string" } } } } } } }, "operationId": "loadSsoLoginConfig" } }, "/oauth/sso/code": { "get": { "tags": [ "Experimental", "SSO Login callback" ], "summary": "Experimental: Callback for SSO login", "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", "responses": { "200": { "description": "Authorisation process continues", "content": { "application/json": { "schema": { "type": "object" } } } }, "302": { "description": "Experimental: Forwards to the Shopware admin" } }, "operationId": "callBackWithCode" } }, "/_info/health-check": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Check that the Application is running", "operationId": "healthCheck", "responses": { "200": { "description": "Returns empty response" }, "500": { "description": "Application is not working properly" } } } }, "/_info/system-health-check": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Perform a detailed system health check", "operationId": "systemHealthCheck", "parameters": [ { "name": "verbose", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Include detailed information in the response" } ], "responses": { "200": { "description": "Returns the system health check results", "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "healthy": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string" }, "extra": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } } } }, "500": { "description": "Application is not working properly" } } } }, "/_action/integration/{integrationId}/mcp-allowlist": { "post": { "tags": [ "MCP", "Experimental" ], "summary": "Save MCP allowlist for an integration", "description": "Saves the per-integration MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `integration_mcp.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "saveMcpAllowlist", "parameters": [ { "name": "integrationId", "in": "path", "required": true, "description": "The integration UUID.", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "security": [ { "oAuth": [ "write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "allowlist" ], "properties": { "allowlist": { "oneOf": [ { "type": "object", "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", "properties": { "tools": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed tool names. Empty array = no tools allowed." }, { "type": "null", "description": "Null = all tools allowed." } ] }, "resources": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed resource URIs. Empty array = no resources allowed." }, { "type": "null", "description": "Null = all resources allowed." } ] }, "prompts": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed prompt names. Empty array = no prompts allowed." }, { "type": "null", "description": "Null = all prompts allowed." } ] } } }, { "type": "null", "description": "Null = all capabilities unrestricted." } ] } } } } } }, "responses": { "204": { "description": "Allowlist saved successfully." }, "400": { "description": "Bad request — missing or invalid `allowlist` field." }, "401": { "description": "Unauthorized — missing or invalid credentials." }, "403": { "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." }, "404": { "description": "Integration not found." } } } }, "/_action/user/{userId}/mcp-allowlist": { "post": { "tags": [ "MCP", "Experimental" ], "summary": "Save MCP allowlist for a user", "description": "Saves the per-user MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `users_and_permissions.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "saveMcpAllowlistUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "The user UUID.", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "security": [ { "oAuth": [ "write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "allowlist" ], "properties": { "allowlist": { "oneOf": [ { "type": "object", "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", "properties": { "tools": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed tool names. Empty array = no tools allowed." }, { "type": "null", "description": "Null = all tools allowed." } ] }, "resources": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed resource URIs. Empty array = no resources allowed." }, { "type": "null", "description": "Null = all resources allowed." } ] }, "prompts": { "oneOf": [ { "type": "array", "items": { "type": "string" }, "description": "List of allowed prompt names. Empty array = no prompts allowed." }, { "type": "null", "description": "Null = all prompts allowed." } ] } } }, { "type": "null", "description": "Null = all capabilities unrestricted." } ] } } } } } }, "responses": { "204": { "description": "Allowlist saved successfully." }, "400": { "description": "Bad request — missing or invalid `allowlist` field." }, "401": { "description": "Unauthorized — missing or invalid credentials." }, "403": { "description": "Forbidden — caller lacks `users_and_permissions.editor` privilege." }, "404": { "description": "User not found." } } } }, "/_action/mcp/tools": { "get": { "tags": [ "MCP", "Experimental" ], "summary": "List registered MCP tools", "description": "Returns all MCP tools currently registered on this Shopware installation. For all capability types (tools, resources, prompts) use `GET /_action/mcp/capabilities` instead. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpToolsList", "security": [ { "oAuth": [ "write" ] } ], "responses": { "200": { "description": "Array of registered MCP tools.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Unique tool identifier used in `tools/call` requests.", "example": "shopware-entity-search" }, "description": { "type": [ "string", "null" ], "description": "Human-readable description of what the tool does.", "example": "Search Shopware entities and return matching records." }, "dependencies": { "type": "array", "items": { "type": "string" }, "description": "Tool names that are automatically included when this tool is selected." }, "requiredPrivileges": { "oneOf": [ { "type": "object", "properties": { "static": { "type": "array", "items": { "type": "string" } }, "entityParam": { "type": [ "string", "null" ] }, "operations": { "type": "array", "items": { "type": "string" } } } }, { "type": "null" } ], "description": "ACL privileges required by this tool." } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials." }, "403": { "description": "Forbidden — caller lacks `integration.editor` privilege." } } } }, "/_action/mcp/capabilities": { "get": { "tags": [ "MCP", "Experimental" ], "summary": "List all registered MCP capabilities", "description": "Returns all registered MCP tools, resources, and prompts. Used by the Admin UI to populate the per-integration allowlist selector. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpCapabilitiesList", "security": [ { "oAuth": [ "write" ] } ], "responses": { "200": { "description": "Object containing all registered MCP capabilities.", "content": { "application/json": { "schema": { "type": "object", "required": [ "tools", "resources", "prompts" ], "properties": { "tools": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "shopware-entity-search" }, "description": { "type": [ "string", "null" ] }, "dependencies": { "type": "array", "items": { "type": "string" } }, "requiredPrivileges": { "oneOf": [ { "type": "object", "properties": { "static": { "type": "array", "items": { "type": "string" } }, "entityParam": { "type": [ "string", "null" ] }, "operations": { "type": "array", "items": { "type": "string" } } } }, { "type": "null" } ] } } } }, "resources": { "type": "array", "items": { "type": "object", "required": [ "uri", "name" ], "properties": { "uri": { "type": "string", "example": "shopware://entity-list" }, "name": { "type": "string", "example": "shopware-entity-list" }, "description": { "type": [ "string", "null" ] }, "mimeType": { "type": [ "string", "null" ] } } } }, "prompts": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "shopware-context" }, "description": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials." }, "403": { "description": "Forbidden — caller lacks `integration.editor` privilege." } } } }, "/_mcp": { "post": { "tags": [ "MCP", "Experimental" ], "summary": "MCP JSON-RPC endpoint", "description": "Handles Model Context Protocol (MCP) requests using the Streamable HTTP transport. Accepts JSON-RPC 2.0 messages for methods such as `initialize`, `tools/list`, `tools/call`, `prompts/list`, `prompts/get`, `resources/list`, and `resources/read`. Requires either an integration access key pair (`sw-access-key` + `sw-secret-access-key` headers) or a standard OAuth2 bearer token. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpPost", "parameters": [ { "name": "mcp-session-id", "in": "header", "required": false, "description": "Session ID returned by the server after `initialize`. Required for all requests except `initialize`.", "schema": { "type": "string" } }, { "name": "sw-access-key", "in": "header", "required": false, "description": "Integration access key for direct credential authentication (alternative to bearer token).", "schema": { "type": "string" } }, { "name": "sw-secret-access-key", "in": "header", "required": false, "description": "Integration secret access key. Required when `sw-access-key` is provided.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "A JSON-RPC 2.0 request or batch.", "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "method": { "type": "string", "example": "tools/call" }, "params": { "type": "object", "additionalProperties": true } } } } } }, "responses": { "200": { "description": "JSON-RPC response or Server-Sent Events stream for long-running operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "result": { "type": "object", "additionalProperties": true }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } } } } }, "text/event-stream": { "schema": { "type": "string", "description": "Server-Sent Events stream for streaming responses." } } } }, "401": { "description": "Unauthorized — missing or invalid credentials." }, "429": { "description": "Too many requests — rate limit exceeded." } } }, "get": { "tags": [ "MCP", "Experimental" ], "summary": "MCP SSE stream", "description": "Opens a Server-Sent Events stream for receiving server-initiated messages. Used by MCP clients that support the SSE transport variant. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpGet", "parameters": [ { "name": "mcp-session-id", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Server-Sent Events stream.", "content": { "text/event-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized." } } }, "delete": { "tags": [ "MCP", "Experimental" ], "summary": "Close MCP session", "description": "Terminates an active MCP session identified by the `mcp-session-id` header. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpDelete", "parameters": [ { "name": "mcp-session-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Session closed successfully." }, "401": { "description": "Unauthorized." } } }, "options": { "tags": [ "MCP", "Experimental" ], "summary": "MCP CORS preflight", "description": "Handles CORS preflight requests for the MCP endpoint. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "mcpOptions", "responses": { "204": { "description": "CORS preflight accepted." } } } }, "/_info/version": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get the Shopware version", "description": "Get the version of the Shopware instance", "operationId": "infoShopwareVersion", "responses": { "200": { "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { "properties": { "version": { "description": "The Shopware version.", "type": "string" } }, "type": "object" } } } } } } }, "/consents": { "get": { "tags": [ "Consent Management", "Experimental" ], "summary": "List all consents for current user", "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "fetchConsents", "responses": { "200": { "description": "List of consents with their status", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConsentState" }, "example": { "product_analytics": { "name": "product_analytics", "scopeName": "admin_user", "identifier": "userId-12345", "status": "accepted", "actor": "userId-12345", "updatedAt": "2024-01-15T10:20:30Z", "acceptedUntil": "2024-01-15T10:20:30Z", "acceptedRevision": "2026-02-01", "latestRevision": "2026-02-01" }, "backend_data": { "name": "backend_data", "scopeName": "system", "identifier": "system", "status": "unset", "actor": null, "updatedAt": null, "acceptedUntil": null, "acceptedRevision": null, "latestRevision": null } } } } } }, "401": { "description": "Unauthorized - User not logged in or invalid session" } } } }, "/consents/accept": { "post": { "tags": [ "Consent Management", "Experimental" ], "summary": "Accept a consent", "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "acceptConsent", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "consent": { "type": "string", "description": "The name of the consent to accept" }, "revision": { "type": [ "string", "null" ], "description": "Optional accepted revision. Only the consent definition's latest revision is accepted. When omitted, the latest revision is used automatically." } }, "required": [ "consent" ], "example": { "consent": "product_analytics", "revision": "2026-02-01" } } } } }, "responses": { "200": { "description": "Consent status changed successfully. Returns the updated consent status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentState" } } } }, "400": { "description": "Bad request - Consent revision is invalid for current acceptance" }, "404": { "description": "Bad request - Consent not found or consent property was empty" }, "401": { "description": "Unauthorized - User not logged in or invalid session" } } } }, "/consents/revoke": { "post": { "tags": [ "Consent Management", "Experimental" ], "summary": "Revoke a consent", "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "operationId": "revokeConsent", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "consent": { "type": "string", "description": "The name of the consent to accept" } }, "required": [ "consent" ], "example": { "consent": "product_analytics" } } } } }, "responses": { "200": { "description": "Consent status changed successfully. Returns the updated consent status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentState" } } } }, "404": { "description": "Bad request - Consent not found or consent property was empty" }, "401": { "description": "Unauthorized - User not logged in or invalid session" } } } }, "/_action/cache": { "delete": { "tags": [ "System Operations" ], "summary": "Clear caches", "description": "The cache is immediately cleared synchronously for all used adapters.", "operationId": "clearCache", "responses": { "204": { "description": "Returns a no content response indicating that the cache has been cleared." } } } }, "/_action/cache-delayed": { "delete": { "tags": [ "System Operations" ], "summary": "Clear all invalidated caches", "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", "operationId": "clearCacheDelayed", "parameters": [ { "name": "refreshOpenSearch", "in": "query", "required": false, "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "description": "Returns a no content response indicating that the cache has been cleared." } } } }, "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ "Customer impersonation" ], "summary": "Generate a customer impersonation token", "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "customerId", "salesChannelId" ], "properties": { "customerId": { "description": "ID of the customer", "type": "string" }, "salesChannelId": { "description": "ID of the sales channel", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { "properties": { "token": { "description": "The generated customer impersonation token", "type": "string" } }, "type": "object" } } } } } } }, "/_info/queue.json": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get message queue statistics (deprecated)", "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", "operationId": "queue", "deprecated": true, "responses": { "200": { "description": "Message queue statistics returned.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Fully qualified class name of the message." }, "size": { "type": "integer", "description": "Number of pending messages of this type." } }, "required": [ "name", "size" ] } }, "example": [ { "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", "size": 150 }, { "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", "size": 25 } ] } } } } } }, "/_action/index-products": { "post": { "tags": [ "System Operations" ], "summary": "Send product indexing message", "description": "Dispatches a product indexing message to the message bus, with the provided ids", "operationId": "productIndexing", "responses": { "204": { "description": "Returns an empty response indicating that the message dispatched." } } } }, "/_info/message-stats.json": { "get": { "summary": "Get statistics message queue", "description": "Get statistics for recently processed messages in the message queue", "operationId": "getMessageStats", "tags": [ "System Info & Health Check" ], "responses": { "200": { "description": "Statistics received", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether message queue statistics are enabled in configuration" }, "stats": { "type": [ "object", "null" ], "properties": { "totalMessagesProcessed": { "type": "integer" }, "processedSince": { "type": "string", "format": "date-time" }, "averageTimeInQueue": { "type": "number", "format": "float" }, "messageTypeStats": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "count": { "type": "integer" } } } } } } } } } } } } } }, "/_action/user/logout": { "post": { "tags": [ "Authorization & Authentication" ], "summary": "Logout the current user", "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", "operationId": "userLogout", "responses": { "204": { "description": "Tokens have been revoked successfully." }, "401": { "description": "Unauthorized - the access token is missing or invalid." }, "403": { "description": "The authenticated source does not have a user ID associated." } } } }, "/_action/scheduled-task/run": { "post": { "tags": [ "System Operations" ], "summary": "Run scheduled tasks.", "description": "Starts the scheduled task worker to handle the next scheduled tasks.", "operationId": "runScheduledTasks", "responses": { "200": { "description": "Returns a success message indicating a successful run.", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Success message", "type": "string" } }, "type": "object" } } } } } } }, "/_action/scheduled-task/min-run-interval": { "get": { "tags": [ "System Operations" ], "summary": "Get the minimum schedules task interval", "description": "Fetches the smallest interval that a scheduled task uses.", "operationId": "getMinRunInterval", "responses": { "200": { "description": "Returns the minimum interval.", "content": { "application/json": { "schema": { "properties": { "minRunInterval": { "description": "Minimal interval in seconds.", "type": "string" } }, "type": "object" } } } } } } }, "/_action/message-queue/consume": { "post": { "tags": [ "System Operations" ], "summary": "Consume messages from the message queue.", "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", "operationId": "consumeMessages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "receiver" ], "properties": { "receiver": { "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about handled messages", "content": { "application/json": { "schema": { "properties": { "handledMessages": { "description": "The number of messages processed.", "type": "integer" } }, "type": "object" } } } } } } }, "/_action/container_cache": { "delete": { "tags": [ "System Operations" ], "summary": "Clear container caches", "description": "The container cache is immediately cleared synchronously.", "operationId": "clearContainerCache", "responses": { "204": { "description": "Returns a no content response indicating that the container cache is cleared." } } } }, "/_action/state-machine/{entityName}/{entityId}/state": { "get": { "tags": [ "State Machine" ], "summary": "Get available transitions for an entity", "description": "Retrieves the available state transitions for the specified entity.", "operationId": "getEntityState", "parameters": [ { "name": "entityName", "in": "path", "description": "Name of the entity.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "Identifier of the entity.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "stateFieldName", "in": "query", "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "required": false, "schema": { "type": "string", "default": "stateId" } } ], "responses": { "200": { "description": "Available transitions for the current state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "transitions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the transition." }, "technicalName": { "type": "string", "description": "The technical name of the transition." }, "actionName": { "type": "string", "description": "The action name of the transition." }, "fromStateName": { "type": "string", "description": "The technical name of the state the transition starts from." }, "toStateName": { "type": "string", "description": "The technical name of the state the transition goes to." }, "url": { "type": "string", "description": "The URL to trigger the transition." } }, "required": [ "name", "technicalName", "actionName", "fromStateName", "toStateName", "url" ] } } }, "required": [ "transitions" ] } } } }, "400": { "description": "Unable to read the entity or entity field." }, "403": { "description": "Forbidden. Missing privileges to access the entity." } } } }, "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { "post": { "tags": [ "State Machine" ], "summary": "Transition an entity to a new state", "description": "Changes the entity state by applying the given transition.", "operationId": "transitionEntityState", "parameters": [ { "name": "entityName", "in": "path", "description": "Name of the entity.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "Identifier of the entity.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "transition", "in": "path", "description": "The `action_name` of the `state_machine_transition`.", "required": true, "schema": { "type": "string" } }, { "name": "stateFieldName", "in": "query", "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "required": false, "schema": { "type": "string", "default": "stateId" } } ], "requestBody": { "description": "Optional internal comment for the state transition.", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalComment": { "type": "string", "description": "An optional internal comment that will be saved with the state transition." } } } } } }, "responses": { "200": { "description": "State transition applied successfully." }, "400": { "description": "Unable to read the entity or entity field, or invalid transition." }, "403": { "description": "Forbidden. Missing privileges to access the entity." } } } }, "/_action/order/document/download": { "post": { "tags": [ "Document Management" ], "summary": "Download a documents", "description": "Download a multiple documents in one pdf file.", "operationId": "downloadDocuments", "requestBody": { "description": "documentIds", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } } } }, "responses": { "200": { "description": "The documents.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/_action/order/document/{documentTypeName}/create": { "post": { "tags": [ "Document Management" ], "summary": "Create documents for orders", "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", "operationId": "createDocuments", "parameters": [ { "name": "documentTypeName", "in": "path", "description": "The type of document to create", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "test", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "orderId", "type" ], "properties": { "orderId": { "description": "Identifier of the order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "description": "Type of the document to be generated.", "type": "string" }, "fileType": { "description": "Type of document file to be generated.", "type": "string", "default": "pdf" }, "static": { "description": "Indicate if the document should be static or not.", "type": "boolean", "default": false }, "referencedDocumentId": { "description": "Identifier of the reverenced document.", "type": "string", "default": "null", "pattern": "^[0-9a-f]{32}$" }, "config": { "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", "type": "object" } } } } } } }, "responses": { "200": { "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ "Order Management" ], "summary": "Transition an order to a new state", "description": "Changes the order state and informs the customer via email if configured.", "operationId": "orderStateTransition", "parameters": [ { "name": "orderId", "in": "path", "description": "Identifier of the order.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "transition", "in": "path", "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "sendMail": { "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "mediaIds": { "description": "A list of media identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "stateFieldName": { "description": "This is the state column within the order database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, "internalComment": { "description": "An optional internal comment that will be saved with the state transition.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Todo: Use ref of `state_machine_transition` here" } } } }, "/_info/openapi3.json": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get OpenAPI Specification", "description": "Get information about the admin API in OpenAPI format.", "operationId": "api-info", "parameters": [ { "name": "type", "in": "query", "description": "Type of the api", "schema": { "type": "string", "enum": [ "jsonapi", "json" ] } } ], "responses": { "200": { "$ref": "#/components/responses/OpenApi3" } } } }, "/_action/sync": { "post": { "tags": [ "Bulk Operations" ], "summary": "Bulk edit entities", "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", "operationId": "sync", "parameters": [ { "name": "fail-on-error", "in": "header", "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { "type": "boolean", "default": true } }, { "name": "indexing-behavior", "in": "header", "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", "schema": { "type": "string", "enum": [ "use-queue-indexing", "disable-indexing" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "action", "entity", "payload" ], "properties": { "action": { "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", "type": "string", "enum": [ "upsert", "delete" ] }, "entity": { "description": "The entity that should be processed with the payload.", "type": "string", "example": "product" }, "payload": { "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", "type": "array", "items": { "type": "object" } }, "criteria": { "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } } }, "type": "object" } } } } }, "responses": { "200": { "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Object with information about updated entities", "type": "object" }, "notFound": { "description": "Object with information about not found entities", "type": "object" }, "deleted": { "description": "Object with information about deleted entities", "type": "object" } }, "type": "object" } } } } } } }, "/_action/mail-template/send": { "post": { "tags": [ "Mail Operations" ], "summary": "Send a mail", "description": "Generates a mail and sends it to the customer. The mail content is rendered with data passed through the request.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", "operationId": "send", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "recipients", "salesChannelId", "contentHtml", "contentPlain", "subject" ], "properties": { "recipients": { "description": "A map of recipients with name and mail address.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } }, "salesChannelId": { "description": "Identifier of the sales channel from which the mail should be send.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "contentHtml": { "description": "The content of the mail in HTML format.", "type": "string" }, "contentPlain": { "description": "The content of the mail as plain text.", "type": "string" }, "subject": { "description": "Subject of the mail.", "type": "string" }, "senderName": { "description": "Name of the sender.", "type": "string" }, "senderEmail": { "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", "type": "string", "format": "email" }, "mediaIds": { "description": "List of media identifiers which should be attached to the mail.", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "documentIds": { "description": "List of document identifiers which should be attached to the mail.", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "binAttachments": { "description": "A list of binary attachments which should be added to the mail.", "type": "array", "items": { "required": [ "content", "fileName", "mimeType" ], "properties": { "content": { "description": "Binary content of the attachment.", "type": "string" }, "fileName": { "description": "File name of the attachment.", "type": "string" }, "mimeType": { "description": "Mime type of the attachment.", "type": "string" } }, "type": "object" } }, "recipientsBcc": { "description": "A mail address or a map of recipients with name and mail address to be set in BCC.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "recipientsCc": { "description": "A mail address or a map of recipients with name and mail address to be set in CC.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "replyTo": { "description": "A mail address or a map of mail addresses with name to be set in reply-to.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "returnPath": { "description": "A mail address or a map of mail addresses with name to be set in return-path.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "mailTemplateId": { "description": "Identifier of the mail template that should be used for attachments and sender defaults.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailTemplateData": { "description": "A map of available data that is used to fill the mail template. Values in this map override generated or entity-derived template data with the same top-level keys.", "type": "object", "additionalProperties": true, "example": { "salesChannel": { "name": "Storefront" } } }, "testMode": { "description": "Enables mail test mode. The mail is still sent, but template rendering runs with the renderer's test mode enabled, a fallback `order.deepLinkCode` of `home` is injected when missing, and debug headers such as `X-Shopware-Language-Id` plus available event or sales-channel headers are added to the message.", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The mail was sent successful", "content": { "application/json": { "schema": { "required": [ "size" ], "properties": { "size": { "description": "Length of the email message", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Invalid request data", "$ref": "#/components/responses/400" } } } }, "/_action/mail-template/validate": { "post": { "tags": [ "Mail Operations" ], "summary": "Validate a mail content", "description": "Validates if content for a mail can be rendered without sending an email.", "operationId": "validate", "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "contentHtml", "contentPlain" ], "properties": { "contentHtml": { "description": "The content of the mail in HTML format.", "type": "string" }, "contentPlain": { "description": "The content of the mail as plain text.", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, "/_action/mail-template/build": { "post": { "tags": [ "Mail Operations" ], "summary": "Build up a mail template", "description": "Generates a preview of a mail template when all the required data is passed through the request.", "operationId": "build", "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "mailTemplateType", "mailTemplate" ], "properties": { "mailTemplateType": { "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", "properties": { "templateData": { "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", "type": "object", "example": { "order": { "orderNumber": 5000, "customerName": "Example Customer" }, "messageOfTheDay": "An apple a day keeps the doctor away!" }, "additionalProperties": true } }, "type": "object" }, "mailTemplate": { "description": "The content of the mail as plain text.", "properties": { "contentHtml": { "description": "The content of the mail template in html format.", "type": "string", "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The rendered simulation result of the mail template parts.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/_action/mail-template/simulate": { "post": { "tags": [ "Mail Operations" ], "summary": "Simulate a mail template", "description": "Generates simulated data for a given event name and renders the provided mail template content against it.", "operationId": "simulateMailTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "templateParts", "eventName" ], "properties": { "templateParts": { "description": "A map of mail template fields and their template content to render.", "type": "object", "additionalProperties": { "type": "string" }, "example": { "subject": "Order {{ order.orderNumber }} confirmation", "senderName": "{{ salesChannel.name }}", "contentHtml": "
Hello {{ order.orderCustomer.firstName }}
", "contentPlain": "Hello {{ order.orderCustomer.firstName }}" } }, "eventName": { "description": "The business event name used to generate simulated mail template data.", "type": "string", "example": "checkout.order.placed" }, "salesChannelId": { "description": "Identifier of the sales channel that should be used for the simulate request.", "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" }, "strictRendering": { "description": "Enables strict variable rendering and surfaces errors for unknown variables. Defaults to `true`.", "type": "boolean", "default": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { "type": "object", "description": "A map of render results keyed by the same field names that were provided in the request's `templateParts` object.", "additionalProperties": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "description": "The type of the render result (either `success` or `error`)", "type": "string", "enum": [ "success", "error" ], "example": "success" }, "content": { "description": "The rendered content of the mail template field. Also contains the error when rendering this field wasn't possible.", "type": "string", "example": "Example mail" } } } } } } }, "400": { "description": "Invalid request data or invalid eventName", "$ref": "#/components/responses/400" } } } }, "/_action/mail-template/preview": { "post": { "tags": [ "Mail Operations" ], "summary": "Preview a mail template", "description": "Fetches the required data needed for the mail template and generates a preview.", "operationId": "mailTemplatePreview", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "mailTemplateId" ], "properties": { "mailTemplateId": { "description": "Identifier of the mail template which should be rendered.", "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b3c4d5e6f7a8b90a1b2c3d4e5f678906" }, "salesChannelId": { "description": "Identifier of the sales channel that should be used for the preview request.", "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" }, "includeHeaderFooter": { "description": "Includes the sales channel mail header and footer in `contentHtml` and `contentPlain`. Defaults to `false`.", "type": "boolean", "default": false }, "strictRendering": { "description": "Enables strict variable rendering and enables errors on e.g. unknown variables. Defaults to `false`.", "type": "boolean", "default": false }, "entities": { "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", "type": "object", "additionalProperties": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "example": { "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" } }, "templateData": { "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", "type": "object", "additionalProperties": true, "example": { "salesChannel": { "name": "Storefront" }, "order": { "orderNumber": "SW10042" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { "type": "object", "required": [ "subject", "senderName", "contentHtml", "contentPlain" ], "properties": { "subject": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "description": "The type of the render result (either `success` or `error`)", "type": "string", "enum": [ "success", "error" ], "example": "success" }, "content": { "description": "The rendered content of the mail template's subject. Also contains the error when rendering this field wasn't possible.", "type": "string", "example": "Example mail" } } }, "senderName": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "description": "The type of the render result (either `success` or `error`)", "type": "string", "enum": [ "success", "error" ], "example": "success" }, "content": { "description": "The rendered content of the mail template's sender name. Also contains the error when rendering this field wasn't possible.", "type": "string", "example": "Storefront" } } }, "contentHtml": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "description": "The type of the render result (either `success` or `error`)", "type": "string", "enum": [ "success", "error" ], "example": "success" }, "content": { "description": "The rendered content of the mail template in html format. Also contains the error when rendering this field wasn't possible.", "type": "string", "example": "
Hello Mr. Mustermann,
this is example mail content, the current date is 16.03.2026.
" } } }, "contentPlain": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "description": "The type of the render result (either `success` or `error`)", "type": "string", "enum": [ "success", "error" ], "example": "success" }, "content": { "description": "The rendered content of the mail template in plain text format. Also contains the error when rendering this field wasn't possible.", "type": "string", "example": "Hello Mr. Mustermann, this is example mail content, the current date is 16.03.2026." } } } } } } } }, "400": { "description": "Invalid request data or invalid mailTemplateId", "$ref": "#/components/responses/400" } } } }, "/_action/mail-template/get-data-and-send": { "post": { "tags": [ "Mail Operations" ], "summary": "Fetch the template data and send a mail", "description": "Generates the required data needed for the mail template, renders the mail content and sends it to the customer.", "operationId": "generateAndSendMail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "mailTemplateId", "recipients", "salesChannelId" ], "properties": { "mailTemplateId": { "description": "Identifier of the mail template which should be rendered.", "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" }, "recipients": { "description": "A map of recipients with name and mail address.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } }, "salesChannelId": { "description": "Identifier of the sales channel from which the mail should be send.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "contentHtml": { "description": "The content of the mail in HTML format. If passed, this content will be used instead of the content from the mail template.", "type": "string" }, "contentPlain": { "description": "The content of the mail as plain text. If passed, this content will be used instead of the content from the mail template.", "type": "string" }, "subject": { "description": "Subject of the mail. If passed, this subject will be used instead of the subject from the mail template.", "type": "string" }, "senderName": { "description": "Name of the sender. If passed, this sender name will be used instead of the sender name from the mail template.", "type": "string" }, "senderEmail": { "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", "type": "string", "format": "email" }, "mediaIds": { "description": "List of media identifiers which should be attached to the mail.", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "documentIds": { "description": "List of document identifiers which should be attached to the mail.", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "binAttachments": { "description": "A list of binary attachments which should be added to the mail.", "type": "array", "items": { "required": [ "content", "fileName", "mimeType" ], "properties": { "content": { "description": "Binary content of the attachment.", "type": "string" }, "fileName": { "description": "File name of the attachment.", "type": "string" }, "mimeType": { "description": "Mime type of the attachment.", "type": "string" } }, "type": "object" } }, "recipientsBcc": { "description": "A mail address or a map of recipients with name and mail address to be set in BCC.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "recipientsCc": { "description": "A mail address or a map of recipients with name and mail address to be set in CC.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "replyTo": { "description": "A mail address or a map of mail addresses with name to be set in reply-to.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "returnPath": { "description": "A mail address or a map of mail addresses with name to be set in return-path.", "oneOf": [ { "type": "string", "format": "email" }, { "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient. Can be null to omit the display name.", "type": [ "string", "null" ] } } ] }, "entities": { "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", "type": "object", "additionalProperties": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "example": { "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" } }, "templateData": { "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", "type": "object", "additionalProperties": true, "example": { "salesChannel": { "name": "Storefront" }, "order": { "orderNumber": "SW10042" } } }, "testMode": { "description": "Enables mail test mode. The mail is still sent, but template rendering runs with the renderer's test mode enabled, a fallback `order.deepLinkCode` of `home` is injected when missing, and debug headers such as `X-Shopware-Language-Id` plus available event or sales-channel headers are added to the message.", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The mail was sent successful", "content": { "application/json": { "schema": { "required": [ "size" ], "properties": { "size": { "description": "Length of the email message", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Invalid request data or invalid mailTemplateId", "$ref": "#/components/responses/400" } } } }, "/_action/mail-template/available-variables": { "post": { "tags": [ "Mail Operations" ], "summary": "Fetch the available variables for a business event and an optional parent variable path.", "description": "Fetches the available variables that a business event provides for a certain parent variable path to determine which variables can be used in a mail template.", "operationId": "mailTemplateAvailableVariables", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "eventName" ], "properties": { "eventName": { "description": "The business event name that provides the available variables.", "type": "string", "example": "checkout.order.placed" }, "parentVariablePath": { "description": "The path to the parent field of which the available variables should be returned. If omitted or empty, the top-level variables of the business event are returned.", "type": "string", "example": "order.transactions" } }, "type": "object" } } } }, "responses": { "200": { "description": "The available variables got fetched successfully.", "content": { "application/json": { "schema": { "items": { "type": "object", "required": [ "fieldName", "hasChildren" ], "properties": { "fieldName": { "description": "The name of the variable.", "type": "string", "example": "salesChannel" }, "hasChildren": { "description": "Shows if behind the variable are more nested variables which can be accessed by another request to this endpoint with the updated parent variable path: `.`", "type": "boolean", "example": true } } }, "type": "array", "description": "A collection of the available variables which also show if behind the variables are more nested variables." } } } }, "400": { "description": "Invalid request data or invalid eventName", "$ref": "#/components/responses/400" } } } }, "/_action/system-config": { "get": { "tags": [ "System Config" ], "summary": "Get configuration values", "description": "Returns the configuration values for the given domain and optional sales channel.", "operationId": "getConfigurationValues", "parameters": [ { "name": "domain", "in": "query", "description": "The configuration domain.", "required": true, "schema": { "type": "string" } }, { "name": "salesChannelId", "in": "query", "description": "The sales channel ID to scope the configuration to.", "schema": { "type": "string" } }, { "name": "inherit", "in": "query", "description": "Whether to include inherited (global) values.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns the configuration values as a key-value object." } } }, "post": { "tags": [ "System Config" ], "summary": "Save configuration values", "description": "Saves the given configuration key-value pairs for the given sales channel.", "operationId": "saveConfiguration", "parameters": [ { "name": "salesChannelId", "in": "query", "description": "The sales channel ID to scope the configuration to.", "schema": { "type": "string" } }, { "name": "silent", "in": "query", "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Key-value pairs of configuration values to save.", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "204": { "description": "Configuration saved successfully." } } } }, "/_action/system-config/check": { "get": { "tags": [ "System Config" ], "summary": "Check configuration", "description": "Checks if a configuration domain exists.", "operationId": "checkConfiguration", "parameters": [ { "name": "domain", "in": "query", "description": "The configuration domain to check.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns whether the configuration domain exists." } } } }, "/_action/system-config/schema": { "get": { "tags": [ "System Config" ], "summary": "Get configuration schema", "description": "Returns the configuration schema for the given domain.", "operationId": "getConfiguration", "parameters": [ { "name": "domain", "in": "query", "description": "The configuration domain.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the configuration schema." } } } }, "/_action/system-config/batch": { "post": { "tags": [ "System Config" ], "summary": "Batch save configuration values", "description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).", "operationId": "batchSaveConfiguration", "parameters": [ { "name": "silent", "in": "query", "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true } } } } }, "responses": { "204": { "description": "Configuration saved successfully." } } } }, "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ "Order Management" ], "summary": "Transition an order delivery to a new state", "description": "Changes the order delivery state and informs the customer via email if configured.", "operationId": "orderDeliveryStateTransition", "parameters": [ { "name": "orderDeliveryId", "in": "path", "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "transition", "in": "path", "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "sendMail": { "description": "Controls if a mail should be send to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "mediaIds": { "description": "A list of media identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "stateFieldName": { "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, "internalComment": { "description": "An optional internal comment that will be saved with the state transition.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Todo: Use ref of `state_machine_transition` here" } } } }, "/_action/validation/email": { "post": { "tags": [ "Email support validation" ], "summary": "Email support.", "description": "Checks a given email string.", "operationId": "supportsEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "description": "The email to be verified.", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Email is supported" }, "400": { "description": "Invalid request payload. The argument 'email' may be missing.", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Contains the error message.", "type": "array" } }, "type": "object" }, "example": { "errors": [ { "code": "0", "status": "400", "title": "Unprocessable Content", "detail": "This value should not be blank." } ] } } } }, "422": { "description": "Email address is not supported.", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Contains the validation error.", "type": "array" } }, "type": "object" }, "example": { "errors": [ { "code": "0", "status": "422", "title": "Unprocessable Content", "detail": "This value is not a supported email address." } ] } } } } } } }, "/_action/index": { "post": { "tags": [ "System Operations" ], "summary": "Run indexer", "description": "Runs all registered indexer in the shop asynchronously.", "operationId": "index", "requestBody": { "content": { "application/json": { "schema": { "properties": { "skip": { "description": "Array of indexers/updaters to be skipped.", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Returns a no content response indicating that the indexing progress startet." } } } }, "/_info/routes": { "get": { "summary": "Get API routes", "operationId": "getRoutes", "tags": [ "System Info & Health Check" ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "endpoints" ], "properties": { "endpoints": { "type": "array", "items": { "type": "object", "required": [ "methods", "path" ], "properties": { "methods": { "type": "array", "items": { "type": "string" } }, "path": { "type": "string" } } } } } } } } } } } }, "/_action/number-range/reserve/{type}/{saleschannel}": { "get": { "tags": [ "Number Range Management" ], "summary": "Reserve or preview a number-range / document number.", "description": "Reserves or previews the next value for a number range type, for example `order`, `customer`, `product`, or `document_invoice`. This route resolves the applicable number range by type and sales channel.\n\nThe generated number will be reserved and the number pointer will be incremented with every call. For preview purposes, add the `?preview=1` parameter to the request. In that case, the number will not be incremented.\n\nWhen editing an existing persisted number range and previewing its concrete state or unsaved pattern/start changes, use `/_action/number-range/{numberRangeId}/preview-pattern` instead.", "operationId": "numberRangeReserve", "parameters": [ { "name": "type", "in": "path", "description": "Technical name of the number range type, for example `order`, `customer`, `product`, or `document_invoice`.", "required": true, "schema": { "type": "string" } }, { "name": "saleschannel", "in": "path", "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", "required": true, "schema": { "type": "string" } }, { "name": "preview", "in": "query", "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The generated number", "content": { "application/json": { "schema": { "properties": { "number": { "description": "The generated or previewed number range value.", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Number range not found" } } } }, "/_action/number-range/{numberRangeId}/preview-pattern": { "get": { "tags": [ "Number Range Management" ], "summary": "Preview a persisted number range", "description": "Previews the next value for a concrete persisted number range without incrementing its state. Optional `pattern` and `start` query parameters can be used to preview unsaved changes while editing the number range. Use `/_action/number-range/reserve/{type}` for actual allocation by business type and sales channel.", "operationId": "numberRangePreviewPatternById", "parameters": [ { "name": "numberRangeId", "in": "path", "description": "Identifier of the number range to preview.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "pattern", "in": "query", "description": "Optional pattern override for the preview.", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "Optional start value override for the preview.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The previewed number", "content": { "application/json": { "schema": { "properties": { "number": { "description": "The previewed number.", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Number range not found" } } } }, "/_action/order_transaction_capture_refund/{refundId}": { "post": { "tags": [ "Order Management" ], "summary": "Refund an order transaction capture", "description": "Refunds an order transaction capture.", "operationId": "orderTransactionCaptureRefund", "parameters": [ { "name": "refundId", "in": "path", "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Refund was successful" }, "400": { "description": "Something went wrong, while processing the refund" }, "404": { "description": "Refund with id not found" } } } }, "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ "Order Management" ], "summary": "Transition an order transaction to a new state", "description": "Changes the order transaction state and informs the customer via email if configured.", "operationId": "orderTransactionStateTransition", "parameters": [ { "name": "orderTransactionId", "in": "path", "description": "Identifier of the order transaction.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "transition", "in": "path", "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "sendMail": { "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "mediaIds": { "description": "A list of media identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "stateFieldName": { "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, "internalComment": { "description": "An optional internal comment that will be saved with the state transition.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, "/_info/config": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get public runtime config & feature metadata", "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", "operationId": "config", "responses": { "200": { "description": "Public runtime configuration & feature metadata returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infoConfigResponse" }, "example": { "version": "6.7.2.0", "shopId": "NoiU8PfJtu7NBY8M", "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", "adminWorker": { "enableAdminWorker": true, "enableNotificationWorker": true, "transports": [ "webhook", "async", "low_priority" ] }, "bundles": { "Administration": { "css": [ "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" ], "js": [ "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" ], "baseUrl": null, "type": "plugin" }, "Storefront": { "css": [ "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" ], "js": [ "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" ], "baseUrl": null, "type": "plugin" } }, "settings": { "enableUrlFeature": true, "appUrlReachable": true, "appsRequireAppUrl": false, "firstMigrationDate": "2025-01-01T12:00:00.000Z", "private_allowed_extensions": [ "jpg", "jpeg", "png", "webp", "avif", "gif", "svg", "bmp", "tiff", "tif", "eps", "webm", "mkv", "flv", "ogv", "ogg", "mov", "mp4", "avi", "wmv", "pdf", "aac", "mp3", "wav", "flac", "oga", "wma", "txt", "doc", "docx", "ico", "glb", "zip", "rar", "csv", "xls", "xlsx", "html", "xml" ], "enableHtmlSanitizer": true, "enableStagingMode": false, "disableExtensionManagement": false }, "inAppPurchases": [] } } } } } } }, "/_action/cleanup": { "delete": { "tags": [ "System Operations" ], "summary": "Clear old cache folders", "description": "Removes cache folders that are not needed anymore.", "operationId": "clearOldCacheFolders", "responses": { "204": { "description": "Returns a no content response indicating that the cleanup finished." } } } }, "/_action/indexing": { "post": { "tags": [ "System Operations" ], "summary": "Run indexer", "description": "Runs all registered indexer in the shop asynchronously.", "operationId": "indexing", "responses": { "200": { "description": "Returns an empty response indicating that the indexing process started." } } } }, "/_action/indexing/{indexer}": { "post": { "tags": [ "System Operations" ], "summary": "Iterate an indexer", "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", "operationId": "iterate", "parameters": [ { "name": "indexer", "in": "path", "description": "Name of the indexer to iterate.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "offset": { "description": "The offset for the iteration.", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { "properties": { "finish": { "description": "Indicates if the indexing process finished.", "type": "boolean" }, "offset": { "description": "Offset to be used for the next iteration.", "type": "integer" } }, "type": "object" } } } } } } }, "/_action/media/{mediaId}/upload": { "post": { "tags": [ "Asset Management" ], "summary": "Upload a file to a media entity", "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", "operationId": "upload", "parameters": [ { "name": "mediaId", "in": "path", "description": "Identifier of the media entity.", "required": true, "schema": { "$ref": "#/components/schemas/MediaId" } }, { "name": "fileName", "in": "query", "description": "Name of the uploaded file. If not provided the media identifier will be used as name", "schema": { "type": "string" } }, { "name": "extension", "in": "query", "description": "Extension of the uploaded file. For example `png`", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "description": "The url of the media file that will be downloaded.", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Media file uploaded successful", "headers": { "Location": { "description": "Contains the url to the uploaded media for a redirect.", "schema": { "type": "string" } } } } } } }, "/_action/media/upload": { "post": { "tags": [ "Asset Management" ], "summary": "Upload a new media file", "description": "Creates a new media entity and uploads a file to it using form-data file upload.", "operationId": "uploadV2", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The file to upload" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Custom ID for the media entity" }, "fileName": { "type": "string", "description": "Name of the uploaded file" }, "private": { "type": "boolean", "description": "Whether the media should be private" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the media folder" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "deduplicate": { "type": "boolean", "description": "Whether to deduplicate based on file hash" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "Media file uploaded successfully", "content": { "application\\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the created media entity" } } } } } } } } }, "/_action/media/upload_by_url": { "post": { "tags": [ "Asset Management" ], "summary": "Upload a media file from URL", "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", "operationId": "uploadByUrl", "requestBody": { "content": { "application\\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the file to download and upload" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Custom ID for the media entity" }, "fileName": { "type": "string", "description": "Name of the uploaded file" }, "private": { "type": "boolean", "description": "Whether the media should be private" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the media folder" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "deduplicate": { "type": "boolean", "description": "Whether to deduplicate based on file hash" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Media file uploaded successfully", "content": { "application\\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the created media entity" } } } } } } } } }, "/_action/media/external-link": { "post": { "tags": [ "Asset Management" ], "summary": "Create external media link", "description": "Creates a new media entity that links to an external URL without downloading the file.", "operationId": "externalLink", "requestBody": { "content": { "application\\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the external media file" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Custom ID for the media entity" }, "fileName": { "type": "string", "description": "Name of the file" }, "private": { "type": "boolean", "description": "Whether the media should be private" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the media folder" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "deduplicate": { "type": "boolean", "description": "Whether to deduplicate based on path" }, "thumbnails": { "type": "array", "description": "Optional list of external thumbnail URLs for the media entity. Used for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.", "items": { "$ref": "#/components/schemas/ExternalThumbnail" } } }, "required": [ "url", "mimeType" ] } } } }, "responses": { "200": { "description": "External media link created successfully", "content": { "application\\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the created media entity" } } } } } } } } }, "/_action/media/presign-upload": { "post": { "tags": [ "Asset Management" ], "summary": "Prepare a presigned upload", "description": "Creates or reuses a media entity and returns a presigned S3 URL for direct browser-to-storage upload. The client uploads the file directly to the returned URL, then calls the finalize endpoint.", "operationId": "presignUpload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fileName", "extension", "mimeType" ], "properties": { "fileName": { "type": "string", "description": "Name of the file without extension" }, "extension": { "type": "string", "description": "File extension, e.g. `jpg`, `png`, `pdf`" }, "mimeType": { "type": "string", "description": "MIME type of the file, e.g. `image/jpeg`" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the media folder to place the new media in" }, "private": { "type": "boolean", "default": false, "description": "Whether the media should be private" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of an existing media entity to replace. If omitted, a new entity is created." } } } } } }, "responses": { "200": { "description": "Presigned upload prepared successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "mediaId", "url", "path", "expiresAt", "isDuplicate" ], "properties": { "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the media entity" }, "url": { "type": "string", "description": "Presigned URL to upload the file to via HTTP PUT" }, "path": { "type": "string", "description": "Storage path of the media file, required for the finalize call" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Expiration time of the presigned URL" }, "isDuplicate": { "type": "boolean", "description": "Whether a file with the same name already exists" } } } } } }, "400": { "description": "Bad request. The file extension is not supported or the file name is invalid.", "$ref": "#/components/responses/400" }, "404": { "description": "The media entity with the given `mediaId` was not found.", "$ref": "#/components/responses/404" }, "422": { "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`) must not be blank.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/failure" } } } } } } }, "/_action/media/{mediaId}/finalize-upload": { "post": { "tags": [ "Asset Management" ], "summary": "Finalize a presigned upload", "description": "Confirms that the file has been uploaded to storage via the presigned URL and updates the media entity with file metadata.", "operationId": "finalizeUpload", "parameters": [ { "name": "mediaId", "in": "path", "required": true, "description": "ID of the media entity to finalize", "schema": { "$ref": "#/components/schemas/MediaId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fileName", "extension", "mimeType", "path" ], "properties": { "fileName": { "type": "string", "description": "Name of the file without extension" }, "extension": { "type": "string", "description": "File extension, e.g. `jpg`, `png`, `pdf`" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "path": { "type": "string", "description": "Storage path returned by the presign-upload endpoint" }, "width": { "type": "integer", "description": "Image width in pixels (optional, for images only)" }, "height": { "type": "integer", "description": "Image height in pixels (optional, for images only)" } } } } } }, "responses": { "200": { "description": "Upload finalized successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "mediaId" ], "properties": { "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the finalized media entity" } } } } } }, "400": { "description": "Bad request. The file extension is not supported, the storage path does not match, the file name is already taken, or the file could not be found on the remote storage.", "$ref": "#/components/responses/400" }, "404": { "description": "The media entity with the given `mediaId` was not found.", "$ref": "#/components/responses/404" }, "422": { "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`, `path`) must not be blank.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/failure" } } } } } } }, "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ "Asset Management" ], "summary": "Add external thumbnails to media", "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", "operationId": "addExternalThumbnails", "parameters": [ { "name": "mediaId", "in": "path", "description": "ID of the external media entity the thumbnails will be attached to.", "required": true, "schema": { "$ref": "#/components/schemas/MediaId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "thumbnails": { "type": "array", "description": "List of external thumbnails to attach", "items": { "$ref": "#/components/schemas/ExternalThumbnail" } } } } } } }, "responses": { "201": { "description": "Thumbnails attached successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "mediaId": { "description": "ID of the media entity the thumbnails were attached to.", "$ref": "#/components/schemas/MediaId" }, "thumbnailsCreated": { "type": "integer" } } } } } }, "400": { "description": "Media is not an external media entity or path is missing" }, "404": { "description": "Media entity not found" } } }, "delete": { "tags": [ "Asset Management" ], "summary": "Delete all external thumbnails from media", "description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.", "operationId": "deleteExternalThumbnails", "parameters": [ { "name": "mediaId", "in": "path", "description": "ID of the external media entity the thumbnails will be deleted from..", "required": true, "schema": { "$ref": "#/components/schemas/MediaId" } } ], "responses": { "200": { "description": "Thumbnails deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "mediaId": { "description": "ID of the media entity the thumbnails were deleted from.", "$ref": "#/components/schemas/MediaId" } } } } } }, "400": { "description": "Media is not an external media entity or path is missing" }, "404": { "description": "Media entity not found" } } } }, "/_action/media/{mediaId}/video-cover": { "post": { "tags": [ "Asset Management" ], "summary": "Assign or remove a video cover image", "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", "operationId": "assignVideoCover", "parameters": [ { "name": "mediaId", "in": "path", "required": true, "description": "ID of the video media entity", "schema": { "$ref": "#/components/schemas/MediaId" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "coverMediaId": { "type": [ "string", "null" ], "pattern": "^[0-9a-f]{32}$", "description": "ID of the image media entity to use as cover. Set to null to remove the cover." } } } } } }, "responses": { "204": { "description": "Video cover assigned or removed successfully" }, "400": { "description": "Invalid request" } } } }, "/_action/order/{orderId}/order-address": { "post": { "tags": [ "Order address" ], "summary": "Update order addresses", "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", "operationId": "updateOrderAddresses", "parameters": [ { "name": "orderId", "in": "path", "description": "Identifier of the order.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mapping": { "type": "array", "items": { "type": "object", "properties": { "customerAddressId": { "type": "string", "description": "The ID of the customer address" }, "type": { "type": "string", "description": "The type of the address" }, "deliveryId": { "description": "The ID of the delivery (optional)", "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "customerAddressId", "type" ] }, "description": "The mapping of order addresses" } } } } }, "required": true }, "responses": { "204": { "description": "Returns a no content response indicating that the update has been made." } } } }, "/_info/events.json": { "get": { "tags": [ "System Info & Health Check" ], "summary": "Get Business events", "description": "Get a list of about the business events.", "operationId": "business-events", "responses": { "200": { "description": "Returns a list of about the business events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessEventsResponse" } } } } } } }, "/app-system/privileges/requested": { "get": { "tags": [ "App System" ], "summary": "Get requested privileges for all apps", "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", "operationId": "getRequestedPrivileges", "security": [ { "oAuth": [ "admin" ] } ], "responses": { "200": { "description": "A JSON object containing requested privileges.", "content": { "application/json": { "schema": { "type": "object", "properties": { "privileges": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "example": { "privileges": { "SwagAnalytics": [ "customer:read", "order:read" ], "SwagExample": [ "product:write" ] } } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Unauthorized Access." }, "403": { "description": "Forbidden. Not a valid integration source." } } } }, "/app-system/{appName}/privileges/accepted": { "get": { "tags": [ "App System" ], "summary": "Get accepted privileges for an app", "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", "operationId": "getAcceptedPrivileges", "parameters": [ { "name": "appName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "oAuth": [ "admin" ] } ], "responses": { "200": { "description": "A JSON object containing accepted privileges.", "content": { "application/json": { "schema": { "type": "object", "properties": { "privileges": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "example": { "privileges": { "customer:read": true, "order:read": true } } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Unauthorized Access." }, "403": { "description": "Forbidden. Not a valid integration source." }, "404": { "description": "App not found." } } } }, "/app-system/{appName}/privileges": { "patch": { "tags": [ "App System" ], "summary": "Accept or revoke privileges for an app", "description": "Accepts or revokes specified privileges for the given app.", "operationId": "managePrivileges", "parameters": [ { "name": "appName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accept": { "type": "array", "items": { "type": "string" } }, "revoke": { "type": "array", "items": { "type": "string" } } } }, "example": { "accept": [ "customer:read", "order:read" ], "revoke": [ "product:write" ] } } } }, "responses": { "204": { "description": "Returns no content if privileges were managed successfully." }, "400": { "description": "Malformed request." }, "401": { "description": "Unauthorized Access." }, "403": { "description": "Forbidden. Not a valid integration source." }, "404": { "description": "App not found." } }, "security": [ { "oAuth": [ "admin" ] } ] } }, "/_action/app-system/secret/rotate": { "post": { "tags": [ "App System" ], "summary": "Initiate secret rotation for the calling app", "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", "operationId": "appSecretRotation", "responses": { "202": { "description": "Returns \"Accepted\" when secret rotation was scheduled." }, "400": { "description": "Malformed request, e.g. when requested with non app integration source." }, "401": { "description": "Unauthorized Access." }, "403": { "description": "Forbidden. Not a valid integration source." }, "404": { "description": "App not found." } }, "security": [ { "oAuth": [ "admin" ] } ] } }, "/app-system/shop/verify": { "get": { "tags": [ "App System", "Public" ], "summary": "Verify a shop's APP_URL", "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", "operationId": "verifyAppUrl", "parameters": [ { "name": "runId", "in": "query", "description": "A unique identifier used to look up the token", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "A unique identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "An empty response signalling successful verification." }, "400": { "description": "Malformed request or unsuccessful verification." } } } }, "/_action/cache_info": { "get": { "tags": [ "System Operations" ], "summary": "Get cache information", "description": "Get information about the cache configuration", "operationId": "info", "responses": { "200": { "description": "Information about the cache state.", "content": { "application/json": { "schema": { "properties": { "environment": { "description": "The active environment.", "type": "string" }, "httpCache": { "description": "State of the HTTP cache.", "type": "boolean" }, "cacheAdapter": { "description": "The active cache adapter.", "type": "string" } }, "type": "object" } } } } } } }, "/_action/increment/{pool}": { "post": { "tags": [ "Increment Storage" ], "summary": "Increment a value in the specified pool", "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", "operationId": "incrementValue", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Optional cluster identifier for the increment operation.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "The key to increment in the pool." } } } } } }, "responses": { "200": { "description": "Successfully incremented the value", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - key parameter missing or cluster parameter missing" } } }, "get": { "tags": [ "Increment Storage" ], "summary": "List increment values from pool", "description": "Retrieves a list of increment values from the specified pool with pagination support.", "operationId": "getIncrementValues", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to list values from.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the increment operation.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of items to return.", "required": false, "schema": { "type": "integer", "default": 5, "minimum": 1 } }, { "name": "offset", "in": "query", "description": "Number of items to skip for pagination.", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "responses": { "200": { "description": "List of increment values", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The increment key" }, "count": { "type": "integer", "description": "The current count value" } } } } } } }, "400": { "description": "Bad request - cluster parameter missing" } } } }, "/_action/decrement/{pool}": { "post": { "tags": [ "Increment Storage" ], "summary": "Decrement a value in the specified pool", "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", "operationId": "decrementValue", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Optional cluster identifier for the decrement operation.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "The key to decrement in the pool." } } } } } }, "responses": { "200": { "description": "Successfully decremented the value", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, "/_action/reset-increment/{pool}": { "post": { "tags": [ "Increment Storage" ], "summary": "Reset increment values in pool", "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", "operationId": "resetIncrementValues", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to reset.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the reset operation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." } } } } } }, "responses": { "200": { "description": "Successfully reset the increment values", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - cluster parameter missing" } } } }, "/_action/delete-increment/{pool}": { "delete": { "tags": [ "Increment Storage" ], "summary": "Delete increment keys from pool", "description": "Deletes specific increment keys from the specified pool.", "operationId": "deleteIncrementKeys", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to delete keys from.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the delete operation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "keys" ], "properties": { "keys": { "type": "array", "items": { "type": "string" }, "description": "Array of keys to delete from the pool." } } } } } }, "responses": { "204": { "description": "Successfully deleted the increment keys" }, "400": { "description": "Bad request - invalid keys parameter or cluster parameter missing" } } } }, "/oauth/sso/auth": { "get": { "tags": [ "Experimental", "SSO Login forward" ], "summary": "Experimental: Redirect to SSO login", "description": "Experimental: Creates a redirection to the SSO login page", "operationId": "ssoAuth", "responses": { "302": { "description": "Experimental: Forwards to SSO login Page" } } } }, "/_info/is-sso": { "get": { "tags": [ "Experimental", "Is SSO environment" ], "summary": "Experimental: Is SSO environment", "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", "operationId": "isSso", "responses": { "200": { "description": "Experimental: Returns if it is a SSO environment or not" } } } }, "/_action/sso/invite-user": { "post": { "tags": [ "Experimental", "Invite a new SSO user" ], "summary": "Experimental: Invite a new SSO user", "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", "operationId": "inviteUser", "responses": { "200": { "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" } } } }, "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ "Document Management" ], "summary": "Download a document", "description": "Download a document by its identifier and deep link code.", "operationId": "downloadDocument", "parameters": [ { "name": "documentId", "in": "path", "description": "Identifier of the document to be downloaded.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "deepLinkCode", "in": "path", "description": "A unique hash code which was generated when the document was created.", "required": true, "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The document.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/_action/document/{documentId}/upload": { "post": { "tags": [ "Document Management" ], "summary": "Upload a file for a document", "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", "operationId": "uploadToDocument", "parameters": [ { "name": "documentId", "in": "path", "description": "Identifier of the document the new file should be added to.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "fileName", "in": "query", "description": "Name of the uploaded file.", "required": true, "schema": { "type": "string" } }, { "name": "extension", "in": "query", "description": "Extension of the uploaded file. For example `pdf`", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "description": "The url of the document that will be downloaded.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Document uploaded successful", "content": { "application/json": { "schema": { "properties": { "documentId": { "description": "Identifier of the document.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentDeepLink": { "description": "A unique hash code which is required to open the document.", "type": "string" } }, "type": "object" } } } } } } }, "/_action/theme/{themeId}": { "patch": { "tags": [ "Theme" ], "summary": "Update theme configuration", "description": "Updates the configuration of a theme. The theme configuration is a collection of fields that are provided as variables in the theme's SCSS files and the templates.", "operationId": "updateThemeConfiguration", "parameters": [ { "name": "themeId", "description": "The ID of the theme to update", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parentThemeId", "description": "The ID of the parent theme to inherit the configuration from.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reset", "description": "If true, the theme configuration will be reset to the default values from the theme.json file.", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "validate", "description": "If true, the theme configuration will be validated before being updated.", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sanitize", "description": "If true, the theme configuration will be sanitized during validation. before being updated. Only applies if validate is true.", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Theme updated successfully.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/_action/theme/{themeId}/configuration": { "get": { "tags": [ "Theme" ], "summary": "Get theme configuration", "description": "Returns the theme configuration including fields, blocks, and current values", "operationId": "getThemeConfiguration", "parameters": [ { "name": "themeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Theme merged configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "helpText": { "type": [ "string", "null" ], "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "type": { "type": "string" }, "value": { "type": [ "string", "null" ] }, "editable": { "type": "boolean" }, "block": { "type": [ "string", "null" ] }, "section": { "type": [ "string", "null" ] }, "tab": { "type": [ "string", "null" ] }, "order": { "type": [ "integer", "null" ] }, "sectionOrder": { "type": [ "integer", "null" ] }, "blockOrder": { "type": [ "integer", "null" ] }, "tabOrder": { "type": [ "integer", "null" ] }, "custom": { "type": [ "object", "null" ], "additionalProperties": true }, "scss": { "type": [ "string", "null" ] }, "fullWidth": { "type": [ "boolean", "null" ] } }, "required": [ "name", "label", "type", "value", "editable" ] } }, "blocks": { "type": "object", "additionalProperties": { "type": "object", "properties": { "label": { "type": "object", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0", "additionalProperties": { "type": "string" } } }, "required": [ "label" ] } }, "configInheritance": { "type": "array", "items": { "type": "string" } }, "themeTechnicalName": { "type": "string" }, "currentFields": { "type": "object", "additionalProperties": { "type": "object", "properties": { "isInherited": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "isInherited", "value" ] } }, "baseThemeFields": { "type": "object", "additionalProperties": { "type": "object", "properties": { "isInherited": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "isInherited", "value" ] } } }, "required": [ "fields", "blocks", "themeTechnicalName", "currentFields", "baseThemeFields" ] } } } } } } }, "/_action/theme/{themeId}/assign/{salesChannelId}": { "post": { "tags": [ "Theme" ], "summary": "Assign theme to sales channel", "description": "Assigns a theme to a specific sales channel", "operationId": "assignTheme", "parameters": [ { "name": "themeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Theme assigned successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/_action/theme/{themeId}/reset": { "patch": { "tags": [ "Theme" ], "summary": "Reset theme configuration", "description": "Resets the theme configuration to its default values", "operationId": "resetTheme", "parameters": [ { "name": "themeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Theme reset successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/_action/theme/{themeId}/structured-fields": { "get": { "tags": [ "Theme" ], "summary": "Get theme configuration fields in structured format", "description": "Returns the theme configuration fields in a structured format with tabs, blocks, sections and fields", "operationId": "getThemeConfigurationStructuredFields", "parameters": [ { "name": "themeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Structured theme configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "tabs": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labelSnippetKey": { "type": "string" }, "label": { "type": "string", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "blocks": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labelSnippetKey": { "type": "string" }, "label": { "type": "string", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "sections": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labelSnippetKey": { "type": "string" }, "label": { "type": "string", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "fields": { "type": "object", "additionalProperties": { "type": "object", "properties": { "labelSnippetKey": { "type": "string" }, "helpTextSnippetKey": { "type": "string" }, "type": { "type": "string" }, "custom": { "type": [ "object", "null" ], "additionalProperties": true }, "fullWidth": { "type": [ "boolean", "null" ] }, "label": { "type": "string", "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" }, "helpText": { "type": [ "string", "null" ], "deprecated": true, "description": "This field is deprecated and will be removed in v6.8.0.0" } }, "required": [ "labelSnippetKey", "helpTextSnippetKey", "type", "label" ] } } }, "required": [ "labelSnippetKey", "label", "fields" ] } } }, "required": [ "labelSnippetKey", "label", "sections" ] } } }, "required": [ "labelSnippetKey", "label", "blocks" ] } } }, "required": [ "tabs" ] } } } } } } } }, "components": { "schemas": { "success": { "required": [ "data" ], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "description": "Link members related to the primary data.", "allOf": [ { "$ref": "#/components/schemas/links" }, { "$ref": "#/components/schemas/pagination" } ] }, "data": { "$ref": "#/components/schemas/data" }, "included": { "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } }, "type": "object", "additionalProperties": false }, "failure": { "required": [ "errors" ], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/error" }, "uniqueItems": true } }, "type": "object", "additionalProperties": false }, "info": { "required": [ "meta" ], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } }, "type": "object" }, "meta": { "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", "type": "object", "additionalProperties": true }, "data": { "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", "oneOf": [ { "$ref": "#/components/schemas/resource" }, { "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } ] }, "resource": { "description": "\"Resource objects\" appear in a JSON API document to represent resources.", "required": [ "type", "id" ], "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "attributes": { "$ref": "#/components/schemas/attributes" }, "relationships": { "$ref": "#/components/schemas/relationships" }, "links": { "$ref": "#/components/schemas/links" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object" }, "relationshipLinks": { "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", "properties": { "self": { "allOf": [ { "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", "type": "array", "items": { "type": "object" } }, { "$ref": "#/components/schemas/link" } ] }, "related": { "$ref": "#/components/schemas/link" } }, "type": "object", "additionalProperties": true }, "links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/link" } }, "link": { "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", "oneOf": [ { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, { "type": "object", "required": [ "href" ], "properties": { "href": { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, "meta": { "$ref": "#/components/schemas/meta" } } } ] }, "attributes": { "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", "type": "object", "additionalProperties": true }, "relationships": { "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", "type": "object", "anyOf": [ { "required": [ "data" ] }, { "required": [ "meta" ] }, { "required": [ "links" ] }, { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/relationshipLinks" }, "data": { "description": "Member, whose value represents \"resource linkage\".", "oneOf": [ { "$ref": "#/components/schemas/relationshipToOne" }, { "$ref": "#/components/schemas/relationshipToMany" } ] } } } ], "additionalProperties": false }, "relationshipToOne": { "allOf": [ { "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." }, { "$ref": "#/components/schemas/linkage" } ] }, "relationshipToMany": { "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", "type": "array", "items": { "$ref": "#/components/schemas/linkage" }, "uniqueItems": true }, "linkage": { "description": "The \"type\" and \"id\" to non-empty members.", "required": [ "type", "id" ], "properties": { "type": { "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "pagination": { "properties": { "first": { "description": "The first page of data", "type": "string", "format": "uri-reference" }, "last": { "description": "The last page of data", "type": "string", "format": "uri-reference" }, "prev": { "description": "The previous page of data", "type": "string", "format": "uri-reference" }, "next": { "description": "The next page of data", "type": "string", "format": "uri-reference" } }, "type": "object" }, "jsonapi": { "description": "An object describing the server's implementation", "properties": { "version": { "type": "string" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "error": { "properties": { "id": { "type": "string", "description": "A unique identifier for this particular occurrence of the problem." }, "links": { "$ref": "#/components/schemas/links" }, "status": { "type": "string", "description": "The HTTP status code applicable to this problem, expressed as a string value." }, "code": { "type": "string", "description": "An application-specific error code, expressed as a string value." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "description": { "type": "string", "description": "A human-readable description of the problem." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." }, "parameter": { "type": "string", "description": "A string indicating which query parameter caused the error." } } }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "AclRoleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the ACL role defined.", "type": "string" }, "description": { "description": "A short description of the ACL role.", "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } }, "deletedAt": { "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "users": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "example": "9bc65c2abec141778ffaa729489f3e87" } } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "integrations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "example": "415320131958c70f4f250ca4d7e63bbd" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AclRole": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ACL role." }, "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" }, "description": "Privileges like read, write, delete, etc." }, "deletedAt": { "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "app": { "$ref": "#/components/schemas/App" }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } }, "type": "object" }, "AclUserRole": { "description": "Added since version: 6.0.0.0", "required": [ "userId", "aclRoleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ACL user role." }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user." }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ACL role." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" }, "aclRole": { "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, "AppJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "path", "version", "integrationId", "aclRoleId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the app.", "type": "string" }, "path": { "description": "A relative URL to the app.", "type": "string" }, "author": { "description": "Creator of the App.", "type": "string" }, "copyright": { "description": "Legal rights on the created app.", "type": "string" }, "license": { "description": "Software license's like MIT, etc.", "type": "string" }, "active": { "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { "description": "Version of the plugin.", "type": "string" }, "icon": { "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "modules": { "type": "array", "items": { "type": "object" } }, "mainModule": { "type": "object" }, "cookies": { "type": "array", "items": { "type": "object" } }, "allowDisable": { "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { "type": "array", "items": { "type": "string" } }, "templateLoadPriority": { "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, "contextGatewayUrl": { "type": "string" }, "inAppPurchasesGatewayUrl": { "type": "string" }, "sourceType": { "type": "string" }, "sourceConfig": { "type": "object" }, "selfManaged": { "type": "boolean" }, "requestedPrivileges": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" }, "description": { "type": "string" }, "privacyPolicyExtensions": { "type": "string" }, "customFields": { "type": "object" }, "integrationId": { "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "integration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "776ea3bf11df5829827f7afb43c37174" } } } }, "type": "object" }, "aclRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "acl_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "250aa1c64b973365fd6fd489eefbdefc" } } } }, "type": "object" }, "customFieldSets": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "example": "9b29ba872ce510f033b31364c8602760" } } } } }, "type": "object" }, "actionButtons": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_action_button" }, "id": { "type": "string", "example": "2c7967427ed432e546ef1c0cb8d5da9e" } } } } }, "type": "object" }, "templates": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_template" }, "id": { "type": "string", "example": "fed36e93a0509e20f2dc96cbbd85b678" } } } } }, "type": "object" }, "webhooks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "webhook" }, "id": { "type": "string", "example": "c10f40999b74c408263f790b30e70efe" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "taxProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_provider" }, "id": { "type": "string", "example": "01a1a9d428b6402dc8255d99c787a00e" } } } } }, "type": "object" }, "cmsBlocks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_cms_block" }, "id": { "type": "string", "example": "3636c4901eab836dfb837e1a9a37d3c0" } } } } }, "type": "object" }, "flowActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_action" }, "id": { "type": "string", "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" } } } } }, "type": "object" }, "flowEvents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_event" }, "id": { "type": "string", "example": "045e9ec14eafd26d17854fb4fe7c9cae" } } } } }, "type": "object" }, "appShippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_shipping_method" }, "id": { "type": "string", "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } } }, "type": "object" }, "mcpTools": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpTools" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_mcp_tool" }, "id": { "type": "string", "example": "6fd6afdbb8880347183b3fd75e779316" } } } } }, "type": "object" }, "mcpPrompts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpPrompts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_mcp_prompt" }, "id": { "type": "string", "example": "dc6c2e9bc841c62a89cf5b3aa42f83d3" } } } } }, "type": "object" }, "mcpResources": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpResources" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_mcp_resource" }, "id": { "type": "string", "example": "8357adcc66e1f74c8b7f688333874068" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "App": { "description": "Added since version: 6.3.1.0", "required": [ "id", "name", "path", "version", "integrationId", "aclRoleId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "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.", "type": "string", "readOnly": true }, "modules": { "type": "array", "items": { "type": "object" }, "description": "Configuration properties or settings related to modules of an app." }, "mainModule": { "type": "object", "description": "Configuration properties or settings related to main modules of an app." }, "cookies": { "type": "array", "items": { "type": "object" }, "description": "Configuration properties or settings related to cookies of an app." }, "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" }, "description": "Indicates the allowed or permitted hosts that the application can communicate with or accept requests from." }, "templateLoadPriority": { "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "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": "Label given to an app." }, "description": { "type": "string", "description": "A short description of app." }, "privacyPolicyExtensions": { "type": "string", "description": "Parameter used to specify extensions or customizations related to the app's privacy policy." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "integrationId": { "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "integration": { "$ref": "#/components/schemas/Integration" }, "aclRole": { "$ref": "#/components/schemas/AclRole" }, "customFieldSets": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } }, "actionButtons": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "taxProviders": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } }, "cmsBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } }, "flowActions": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } }, "flowEvents": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } }, "appShippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } }, "mcpTools": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpTool" } }, "mcpPrompts": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpPrompt" } }, "mcpResources": { "type": "array", "items": { "$ref": "#/components/schemas/AppMcpResource" } } }, "type": "object" }, "AppActionButtonJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "entity", "view", "url", "action", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "description": "Indicates in which particular entity.", "type": "string" }, "view": { "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": [ "id", "entity", "view", "url", "action", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's action button." }, "entity": { "description": "Indicates in which particular entity.", "type": "string" }, "view": { "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string", "description": "Label given to AppActionButton." }, "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", "description": "Contains the translations of all translated fields." }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppAdministrationSnippetJsonApi": { "description": "Added since version: 6.4.15.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "value", "appId", "localeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "AppAdministrationSnippet": { "description": "Added since version: 6.4.15.0", "required": [ "id", "value", "appId", "localeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's administration snippet." }, "value": { "type": "string", "description": "Value of App Administration Snippet." }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app." }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity that specifies the language and country. " }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppCmsBlockJsonApi": { "description": "Added since version: 6.4.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "block", "template", "styles", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { "description": "Template that defines app CMS block.", "type": "string" }, "styles": { "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ "id", "name", "block", "template", "styles", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's CMS block." }, "name": { "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object", "description": "CMS block." }, "template": { "description": "Template that defines app CMS block.", "type": "string" }, "styles": { "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string", "description": "Label given to AppCmsBlock." }, "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", "description": "Contains the translations of all translated fields." }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppFlowActionJsonApi": { "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "appId", "name", "url", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of app flow action.", "type": "string" }, "badge": { "type": "string" }, "parameters": { "type": "object" }, "config": { "type": "object" }, "headers": { "type": "object" }, "requirements": { "type": "array", "items": { "type": "string" } }, "iconRaw": { "type": "string" }, "icon": { "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "swIcon": { "type": "string" }, "url": { "description": "An URL to app flow action.", "type": "string" }, "delayable": { "type": "boolean" }, "label": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": [ "id", "appId", "name", "url", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's flow action." }, "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", "description": "Parameters that hold data required for the specific action to be executed within flow." }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "headers": { "type": "object", "description": "Indicates the header value within the context of app flow action." }, "requirements": { "type": "array", "items": { "type": "string" } }, "iconRaw": { "type": "string" }, "icon": { "description": "Icon to identify app flow action.", "type": "string", "readOnly": true }, "swIcon": { "type": "string" }, "url": { "description": "An URL to app flow action.", "type": "string" }, "delayable": { "type": "boolean" }, "label": { "type": "string", "description": "Label given to AppFlowAction." }, "description": { "type": "string", "description": "A short description of AppFlowAction." }, "headline": { "type": "string", "description": "A headline or title associated with the action." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "app": { "$ref": "#/components/schemas/App" }, "flowSequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } }, "type": "object" }, "AppFlowEventJsonApi": { "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "appId", "name", "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "flows": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "id": { "type": "string", "example": "0db2dd944f9ee9a131f44b79d331d371" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppFlowEvent": { "description": "Added since version: 6.5.2.0", "required": [ "id", "appId", "name", "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app flow event." }, "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" }, "description": "Parameter that indicates the areas in which the app flow event is supported." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "flows": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } }, "type": "object" }, "AppMcpPromptJsonApi": { "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "url": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-mcp-prompt/0f7619363286401a53877794cfb6ebbb/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppMcpPrompt": { "description": "Added since version: 6.7.11.0", "required": [ "id", "name", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "url": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppMcpResourceJsonApi": { "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "uri", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "uri": { "type": "string" }, "url": { "type": "string" }, "mimeType": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-mcp-resource/30e270c9edfb6e58051d304c6e69e7bf/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppMcpResource": { "description": "Added since version: 6.7.11.0", "required": [ "id", "name", "uri", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "uri": { "type": "string" }, "url": { "type": "string" }, "mimeType": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppMcpToolJsonApi": { "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "url": { "type": "string" }, "inputSchema": { "type": "object" }, "requiredPrivileges": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-mcp-tool/0d217ec15d0377a62d13caf5899f0212/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppMcpTool": { "description": "Added since version: 6.7.11.0", "required": [ "id", "name", "url", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "url": { "type": "string" }, "inputSchema": { "type": "object" }, "requiredPrivileges": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppPaymentMethodJsonApi": { "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "appName", "identifier", "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "description": "Name of the app.", "type": "string" }, "identifier": { "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "originalMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", "required": [ "id", "appName", "identifier", "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's payment method." }, "appName": { "description": "Name of the app.", "type": "string" }, "identifier": { "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "originalMedia": { "$ref": "#/components/schemas/Media" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "AppScriptConditionJsonApi": { "description": "Added since version: 6.4.10.3", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "identifier", "active", "appId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "ruleConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "24bfabce4195894c9aed9b8bcfb0b748" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": [ "id", "identifier", "active", "appId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app's script condition." }, "identifier": { "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string", "description": "Unique name of app's script condition." }, "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", "description": "Specifies detailed information about the component." }, "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", "description": "Contains the translations of all translated fields." }, "app": { "$ref": "#/components/schemas/App" }, "ruleConditions": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, "AppShippingMethodJsonApi": { "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "appName", "identifier", "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "originalMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppShippingMethod": { "description": "Added since version: 6.5.7.0", "required": [ "id", "appName", "identifier", "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "originalMedia": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "AppTemplateJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "template", "path", "active", "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "template": { "description": "Template for an app.", "type": "string" }, "path": { "description": "A relative URL to the app template.", "type": "string" }, "active": { "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppTemplate": { "description": "Added since version: 6.3.1.0", "required": [ "id", "template", "path", "active", "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of App template." }, "template": { "description": "Template for an app.", "type": "string" }, "path": { "description": "A relative URL to the app template.", "type": "string" }, "active": { "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "breadcrumb": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "level": { "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { "description": "A relative URL to the category.", "type": "string", "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", "type": "string", "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" }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "navigationSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "04db458d860e0a4b455ae14b384a5e8a" } } } } }, "type": "object" }, "footerSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "57944aba1f6dea7ca9dacf66776e1755" } } } } }, "type": "object" }, "serviceSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "1a79932fadba3b20baf6369181e45602" } } } } }, "type": "object" }, "mainCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "main_category" }, "id": { "type": "string", "example": "1fb731fc4139cbb575429e28846f0c39" } } } } }, "type": "object" }, "seoUrls": { "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "seo_url" }, "id": { "type": "string", "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "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}$", "description": "Unique identity of category." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of category's version." }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent category." }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent category's version." }, "afterCategoryId": { "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the category's version under which the new category is to be created." }, "mediaId": { "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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, "description": "Breadcrumbs offer the users on the website the option to quickly find their way back to the homepage or another level of the website using internal links." }, "level": { "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree. ", "type": "integer", "format": "int64", "readOnly": true }, "path": { "description": "A relative URL to the category.", "type": "string", "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true, "description": "Number of categories below the main category." }, "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", "description": "Name of the category." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "slotConfig": { "type": "object", "description": "Specifies detailed information about how the CMS slots are configured for category." }, "linkType": { "type": "string", "enum": [ "category", "product", "external", "landing_page" ], "description": "linkType : `external`, `category`, `product`, `landing_page`." }, "internalLink": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "When a particular category is clicked, it gets redirected to internal link." }, "externalLink": { "type": "string", "description": "When a particular category is clicked, it gets redirected to external link." }, "linkNewTab": { "type": "boolean", "description": "Category opens in a new tab of the browser." }, "description": { "type": "string", "description": "Information about the category." }, "metaTitle": { "type": "string", "description": "A page title indexed by search engines and appears in search results listings." }, "metaDescription": { "type": "string", "description": "A short description of the page for search results listings." }, "keywords": { "type": "string", "description": "Keywords that help to search the category." }, "cmsPageId": { "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page's version." }, "productStreamId": { "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of custom entity type." }, "cmsPageIdSwitched": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "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}$", "description": "Unique identity of category tag." }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of category." }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of category's version." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag." }, "category": { "$ref": "#/components/schemas/Category" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "CmsBlockJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "position", "type", "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { "properties": { "mobile": { "type": "boolean" }, "desktop": { "type": "boolean" }, "tablet": { "type": "boolean" } }, "type": "object" }, "sectionId": { "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "section": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "73d5342eba070f636ac3246f319bf77f" } } } }, "type": "object" }, "backgroundMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, "slots": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_slot" }, "id": { "type": "string", "example": "a8b72798beb911ae98c8c8907d45950a" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ "id", "position", "type", "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS block." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS Block version." }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS Section version." }, "position": { "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", "description": "When locked, then CmsBlock cannot be configured." }, "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", "description": "When `true`, CMS layout can be viewed in mobile mode." }, "desktop": { "type": "boolean", "description": "When `true`, CMS layout can be viewed in desktop mode." }, "tablet": { "type": "boolean", "description": "When `true`, CMS layout can be viewed in tablet mode." } }, "type": "object" }, "sectionId": { "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_section" }, "id": { "type": "string", "example": "ff4dee88db82e98f0e0d524d965b9aa7" } } } } }, "type": "object" }, "previewMedia": { "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "landingPages": { "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } } }, "type": "object" }, "homeSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "9aed0c38161f67f2d40a4a872cae045f" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsPage": { "description": "Added since version: 6.0.0.0", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page version." }, "name": { "type": "string", "description": "Name of the CMS page." }, "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", "description": "Background color of the CMS page." } }, "type": "object" }, "previewMediaId": { "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "locked": { "type": "boolean", "description": "When locked, then CmsPage cannot be configured." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "sections": { "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { "$ref": "#/components/schemas/Media", "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": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "71860c77c6745379b0d44304d66b6a13" } } } }, "type": "object" }, "backgroundMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, "blocks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "example": "e734964953f880e5164e32827950ff92" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ "id", "position", "type", "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS section." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS section's version." }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page version." }, "position": { "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string", "enum": [ "default", "sidebar" ] }, "locked": { "type": "boolean", "description": "When locked, then CmsSection cannot be configured." }, "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", "description": "When `true`, CMS layout can be viewed in mobile mode." }, "desktop": { "type": "boolean", "description": "When `true`, CMS layout can be viewed in desktop mode." }, "tablet": { "type": "boolean", "description": "When `true`, CMS layout can be viewed in tablet mode." } }, "type": "object" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "14511f2f5564650d129ca7cabc333278" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ "id", "type", "slot", "blockId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS slot." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS block version." }, "fieldConfig": { "type": "object", "description": "Con info of cms slot" }, "type": { "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", "description": "When locked, then CMS slot config element cannot be configured." }, "config": { "type": "object", "description": "Specifies detailed information about how the component is to be rendered." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "data": { "type": "object", "readOnly": true, "description": "Each cms slot (element) has a config that has values defined in the admin. When cms loads, each Resolver class adds the resolved config data to this value." }, "blockId": { "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "block": { "$ref": "#/components/schemas/CmsBlock" }, "VersionId": { "description": "Unique identity of CMS slot's version." } }, "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" }, "relationships": { "properties": { "states": { "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } } }, "type": "object" }, "customerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } } }, "type": "object" }, "orderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "c3182f0dc0cc20b4982616d3e0221747" } } } } }, "type": "object" }, "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "taxRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule" }, "id": { "type": "string", "example": "1b93ada511aac379c19d3afcba4e4041" } } } } }, "type": "object" }, "currencyCountryRoundings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "currency_country_rounding" }, "id": { "type": "string", "example": "35ef8dd5459bf5f08d44cb278bf07cd4" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Country": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the country." }, "name": { "type": "string", "description": "Name of the country." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "customerTax": { "required": [ "enabled", "currencyId", "amount" ], "properties": { "enabled": { "type": "boolean", "description": "The boolean value is `true` if the tax for the customer apply." }, "currencyId": { "type": "string", "description": "Unique identity of currency." }, "amount": { "type": "number", "format": "float", "description": "Sum of money to be paid by the customer." } }, "type": "object" }, "companyTax": { "required": [ "enabled", "currencyId", "amount" ], "properties": { "enabled": { "type": "boolean", "description": "The boolean value is `true`, if the tax for the company apply." }, "currencyId": { "type": "string", "description": "Unique identity of currency." }, "amount": { "type": "number", "format": "float", "description": "Sum of money to be paid by the company." } }, "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", "description": "The address format with recipient's name, building number, street name, city, state and ZIP code on different lines as required." }, "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", "description": "Contains the translations of all translated fields." }, "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" }, "relationships": { "properties": { "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "customerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } } }, "type": "object" }, "orderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "c3182f0dc0cc20b4982616d3e0221747" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ "id", "countryId", "shortCode", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the country's state." }, "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", "description": "Name of the country's state." }, "position": { "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "country": { "$ref": "#/components/schemas/Country" }, "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "orderAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } }, "type": "object" }, "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "factor", "symbol", "isoCode", "itemRounding", "totalRounding", "shortName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "factor": { "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { "type": "string" }, "name": { "type": "string" }, "position": { "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, "isSystemDefault": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "taxFreeFrom": { "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, "customFields": { "type": "object" }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "salesChannelDomains": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } } }, "type": "object" }, "promotionDiscountPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount_prices" }, "id": { "type": "string", "example": "325723473ecab76b0f45e1554513f779" } } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" }, "countryRoundings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "currency_country_rounding" }, "id": { "type": "string", "example": "3de4aa80c8c8822ea10d156a6f58d6f7" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", "factor", "symbol", "isoCode", "itemRounding", "totalRounding", "shortName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of currency." }, "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", "description": "Acronym for international currencies. For example, USD." }, "name": { "type": "string", "description": "Full name of the currency. For example, US-Dollar." }, "position": { "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on net prices. " } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the round off amount to the nearest decimal points applied on the cart’s total amount. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval defines the cart’s total amount round off interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on cart’s total net prices. " } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannelDomains": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } }, "promotionDiscountPrices": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } }, "countryRoundings": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, "type": "object" }, "CurrencyCountryRoundingJsonApi": { "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "currencyId", "countryId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", "required": [ "id", "currencyId", "countryId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the country's currency rounding." }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the currency." }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the country." }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on net prices." } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on net prices. " } }, "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}$", "description": "Unique identity of a custom entity." }, "name": { "description": "Unique name of the entity.", "type": "string" }, "fields": { "type": "object", "description": "Fields in custom entity." }, "flags": { "type": "object", "description": "Indicators used to specify certain settings or characteristics associated with the custom entity." }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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": { "type": "object" }, "active": { "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, "includeInSearch": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFieldSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, "productSearchConfigFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config_field" }, "id": { "type": "string", "example": "ae6a70432f71d6905502769f184399b1" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomField": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of a custom field." }, "name": { "description": "Unique name of a custom field.", "type": "string" }, "type": { "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "active": { "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, "includeInSearch": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" }, "productSearchConfigFields": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } }, "type": "object" }, "CustomFieldSetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field" }, "id": { "type": "string", "example": "4e252ff73243c27b4df9002e452fc6a7" } } } } }, "type": "object" }, "relations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set_relation" }, "id": { "type": "string", "example": "06c5b10273a69992d8c6933e294909fa" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of a custom field set." }, "name": { "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "active": { "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "CustomFieldSetRelationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customFieldSetId", "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFieldSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ "id", "customFieldSetId", "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of a custom field set relation." }, "customFieldSetId": { "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, "CustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "groupId", "salesChannelId", "languageId", "defaultBillingAddressId", "defaultShippingAddressId", "customerNumber", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "customerNumber": { "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "email": { "description": "Email ID of the customer.", "type": "string" }, "title": { "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { "description": "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 }, "orderCount": { "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true }, "customFields": { "type": "object" }, "remoteAddress": { "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "requestedGroupId": { "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "salesChannelTracking": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "group": { "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "lastPaymentMethod": { "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bb083200005a374b86f6f5fbbff6f0e0" } } } }, "type": "object" }, "defaultBillingAddress": { "description": "Default billing address for the customer", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } }, "type": "object" }, "activeBillingAddress": { "description": "Currently active billing address in the session", "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" }, "orderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_customer" }, "id": { "type": "string", "example": "1e7dbe7e3bcb48d233fd80588f54c980" } } } } }, "type": "object" }, "tags": { "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "promotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "ea6aeb050f871384f25fba9c869cfe21" } } } } }, "type": "object" }, "productReviews": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review" }, "id": { "type": "string", "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" }, "recoveryCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ce9d8d13e51bf43bc70a4be38950823b" } } } }, "type": "object" }, "requestedGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "46cf25a3f20102ff5e1e17526fb73b62" } } } }, "type": "object" }, "boundSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "dfe8aec35136b1f62669b388a291a4c7" } } } }, "type": "object" }, "wishlists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist" }, "id": { "type": "string", "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Customer": { "description": "Added since version: 6.0.0.0", "required": [ "id", "groupId", "salesChannelId", "languageId", "defaultBillingAddressId", "defaultShippingAddressId", "customerNumber", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer." }, "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, "description": "Internal field." }, "customerNumber": { "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "email": { "description": "Email ID of the customer.", "type": "string" }, "title": { "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { "description": "Password hash for customer recovery.", "type": "string" }, "guest": { "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "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, "description": "Unique identity of tag." }, "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": { "salesChannelTracking": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" } }, "type": "object" }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language", "description": "Preferred language for customer communication" }, "lastPaymentMethod": { "$ref": "#/components/schemas/PaymentMethod", "description": "Last used payment method by the customer" }, "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress", "description": "Default billing address for the customer" }, "activeBillingAddress": { "$ref": "#/components/schemas/CustomerAddress", "description": "Currently active billing address in the session" }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress", "description": "Default shipping address for the customer" }, "activeShippingAddress": { "$ref": "#/components/schemas/CustomerAddress", "description": "Currently active shipping address in the session" }, "salutation": { "$ref": "#/components/schemas/Salutation", "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, "addresses": { "description": "All addresses saved for the customer", "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "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": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "defaultPaymentMethodId": { "description": "Unique identity of default payment method." }, "company": { "description": "Company name of the customer." }, "vatIds": { "description": "Unique identity of VAT." }, "accountType": { "description": "Account type can be personal or business." } }, "type": "object" }, "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customerId", "countryId", "firstName", "lastName", "city", "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "zipcode": { "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { "description": "Name of customer's city.", "type": "string" }, "company": { "description": "Name of customer's company.", "type": "string" }, "street": { "description": "Name of customer's street.", "type": "string" }, "department": { "description": "Name of customer's department.", "type": "string" }, "title": { "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { "description": "Additional customer's address information.", "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "countryState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", "customerId", "countryId", "firstName", "lastName", "city", "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of customer's address." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "CustomerGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "displayGross": { "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { "type": "string" }, "registrationIntroduction": { "type": "string" }, "registrationOnlyCompanyRegistration": { "type": "boolean" }, "registrationSeoMetaDescription": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "registrationSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "ffc8e76c1fe257d563b9d0024a50620b" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer's group." }, "name": { "type": "string", "description": "Name of the customer group." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "registrationActive": { "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { "type": "string", "description": "Title defined for the customer group during registration." }, "registrationIntroduction": { "type": "string", "description": "A brief description about the registration." }, "registrationOnlyCompanyRegistration": { "type": "boolean", "description": "Register as a company rather than as a private customer group." }, "registrationSeoMetaDescription": { "type": "string", "description": "A short description of the registration page for search results listings." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "registrationSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "CustomerGroupRegistrationSalesChannels": { "description": "Added since version: 6.3.1.0", "required": [ "customerGroupId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer group registration sales channel." }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer group." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the sales channel." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "CustomerRecoveryJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "hash", "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerRecovery": { "description": "Added since version: 6.1.0.0", "required": [ "id", "hash", "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer recovery account." }, "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" }, "CustomerTag": { "description": "Added since version: 6.0.0.0", "required": [ "customerId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer tag." }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the tag." }, "customer": { "$ref": "#/components/schemas/Customer" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "CustomerWishlistJsonApi": { "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customerId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist_product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerWishlist": { "description": "Added since version: 6.3.4.0", "required": [ "id", "customerId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the customer's wishlist." }, "customerId": { "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } }, "customer": { "$ref": "#/components/schemas/Customer" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "CustomerWishlistProductJsonApi": { "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "wishlist": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "723edf7c24638ed18d2fa831e647a5cc" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerWishlistProduct": { "description": "Added since version: 6.3.4.0", "required": [ "id", "productId", "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product in customer wishlist." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "wishlistId": { "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "wishlist": { "$ref": "#/components/schemas/CustomerWishlist" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "DeliveryTimeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "min", "max", "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "min": { "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "min", "max", "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of delivery time." }, "name": { "type": "string", "description": "Name given to delivery time." }, "min": { "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "DocumentJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentTypeId", "orderId", "config", "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "config": { "type": "object" }, "sent": { "type": "boolean" }, "static": { "type": "boolean" }, "deepLinkCode": { "type": "string" }, "documentNumber": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "referencedDocument": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "75c3c346b0ef4f319e71925ce164a9ae" } } } }, "type": "object" }, "dependentDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "e74b269b7d5f269051463569677da2a0" } } } } }, "type": "object" }, "documentMediaFile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ac7db1e6be481d6422fc63700e08279d" } } } }, "type": "object" }, "documentA11yMediaFile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0ea973a1104089c9d0f93bdb06c47cab" } } } }, "type": "object" }, "documentFiles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentFiles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_file" }, "id": { "type": "string", "example": "aad3bfae9fe3322b72a0bfbdda842b11" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", "documentTypeId", "orderId", "config", "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document." }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document type." }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of reference document." }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the order." }, "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document media file." }, "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the order's version." }, "config": { "type": "object", "description": "Specifies detailed information about how a document component is to be rendered." }, "sent": { "type": "boolean", "description": "When `true`, the document is already sent to the customer." }, "static": { "type": "boolean", "description": "When `true`, the document is uploaded else it is generated by the system." }, "deepLinkCode": { "type": "string", "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." }, "documentNumber": { "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "order": { "$ref": "#/components/schemas/Order" }, "referencedDocument": { "$ref": "#/components/schemas/Document" }, "dependentDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "documentMediaFile": { "$ref": "#/components/schemas/Media" }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" }, "documentFiles": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentFile" } }, "fileType": { "description": "Type of file like PDF." } }, "type": "object" }, "DocumentBaseConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentTypeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the document.", "type": "string" }, "filenamePrefix": { "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { "description": "Unique number associated with every document.", "type": "string" }, "pageSize": { "description": "The page size of the document.", "type": "string" }, "pageOrientation": { "description": "The page orientation of the document.", "type": "string" }, "itemsPerPage": { "description": "The number of items per page.", "type": "integer", "format": "int64" }, "displayHeader": { "description": "Whether to display the header.", "type": "boolean" }, "displayFooter": { "description": "Whether to display the footer.", "type": "boolean" }, "displayPageCount": { "description": "Whether to display the page count.", "type": "boolean" }, "displayCompanyAddress": { "description": "Whether to display the company address.", "type": "boolean" }, "displayReturnAddress": { "description": "Whether to display the return address.", "type": "boolean" }, "displayCustomerVatId": { "description": "Whether to display the customer VAT ID.", "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "config": { "type": "object", "deprecated": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "logo": { "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config_sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ "id", "documentTypeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the document base config." }, "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" }, "pageSize": { "description": "The page size of the document.", "type": "string" }, "pageOrientation": { "description": "The page orientation of the document.", "type": "string" }, "itemsPerPage": { "description": "The number of items per page.", "type": "integer", "format": "int64" }, "displayHeader": { "description": "Whether to display the header.", "type": "boolean" }, "displayFooter": { "description": "Whether to display the footer.", "type": "boolean" }, "displayPageCount": { "description": "Whether to display the page count.", "type": "boolean" }, "displayCompanyAddress": { "description": "Whether to display the company address.", "type": "boolean" }, "displayReturnAddress": { "description": "Whether to display the return address.", "type": "boolean" }, "displayCustomerVatId": { "description": "Whether to display the customer VAT ID.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "config": { "type": "object", "deprecated": true, "description": "Specifies detailed information about the component." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "logo": { "$ref": "#/components/schemas/Media", "description": "Logo in the document at the top-right corner." }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } }, "type": "object" }, "DocumentBaseConfigSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "documentBaseConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56e59df02965ebf8eadea49fa0aadd47" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document's base config sales channel." }, "documentBaseConfigId": { "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, "DocumentFileJsonApi": { "description": "Added since version: 6.7.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentId", "mediaId", "documentFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentFormat": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "document": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/document" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fdc3bdefb79cec8eb8211d2499e04704" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentFile": { "description": "Added since version: 6.7.10.0", "required": [ "id", "documentId", "mediaId", "documentFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentFormat": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "document": { "$ref": "#/components/schemas/Document" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "description": "Technical name of document type.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "documents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "21f64da1e5792c8295b964d159a14491" } } } } }, "type": "object" }, "documentBaseConfigs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config" }, "id": { "type": "string", "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } } }, "type": "object" }, "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config_sales_channel" }, "id": { "type": "string", "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the document type." }, "name": { "type": "string", "description": "Name of the document type." }, "technicalName": { "description": "Technical name of document type.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "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 }, "relationships": { "properties": { "sequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "eb6710ddc89dae357ae94ca3974b1e38" } } } } }, "type": "object" }, "appFlowEvent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_event" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d92d404135abc21e31337d9509cbe62f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Flow": { "description": "Added since version: 6.4.6.0", "required": [ "id", "name", "eventName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of flow." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "appFlowEventId": { "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "appFlowEvent": { "$ref": "#/components/schemas/AppFlowEvent" } }, "type": "object" }, "FlowSequenceJsonApi": { "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "flowId": { "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 }, "relationships": { "properties": { "flow": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "parent": { "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "appFlowAction": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8ba9ae8a60ecf9be421e333b95703a68" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "FlowSequence": { "description": "Added since version: 6.4.6.0", "required": [ "id", "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of flow sequence." }, "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", "description": "Specifies detailed information about the component." }, "position": { "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "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}$", "description": "Unique identity of parent." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "appFlowActionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "flow": { "$ref": "#/components/schemas/Flow" }, "rule": { "$ref": "#/components/schemas/Rule" }, "parent": { "$ref": "#/components/schemas/FlowSequence", "description": "Unique identity of flow sequence." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "appFlowAction": { "$ref": "#/components/schemas/AppFlowAction" }, "appFlowEventId": { "description": "Unique identity of app flow event." } }, "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}$", "description": "Unique identity of flow template." }, "name": { "description": "Name of the flow template.", "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ImportExportFile": { "description": "Added since version: 6.0.0.0", "required": [ "id", "originalName", "path", "expireDate" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of import-export file." }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "profile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_profile" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7d97481b1fe66f4b51db90da7e794d9f" } } } }, "type": "object" }, "file": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_file" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8c7dd922ad47494fc02c388e12c00eac" } } } }, "type": "object" }, "invalidRecordsLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "46eeeb74b58b97a6a05494fa0024c998" } } } }, "type": "object" }, "failedImportLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1d6996fa1560fc40e5faad086b07ad18" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ImportExportLog": { "description": "Added since version: 6.0.0.0", "required": [ "id", "activity", "state", "records", "config" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of import-export log." }, "activity": { "type": "string", "description": "Information about a specific activity or operation associated with an import-export event." }, "state": { "type": "string", "description": "Parameter that indicates the status of an import-export process whether it is in progress, completed, or has encountered an error, for example." }, "records": { "type": "integer", "format": "int64", "description": "Indicates the number of records involved in an import-export process." }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the user." }, "profileId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the profile." }, "fileId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the file." }, "invalidRecordsLogId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the invalid record logs." }, "username": { "type": "string", "description": "Username of the user who initiated the import-export operation." }, "profileName": { "type": "string", "description": "Name of the profile used for the import-export process." }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "result": { "type": "object", "description": "The result or outcome of an import-export operation." }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "example": "e4ca733e3c1da4bff4cd4b6078f2237a" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ImportExportProfile": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "label", "sourceEntity", "fileType", "delimiter", "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of import-export profile." }, "technicalName": { "type": "string" }, "label": { "type": "string", "description": "Label given to ImportExportProfile." }, "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", "description": "Defines the connection to the different database columns." }, "updateBy": { "type": "object" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "importExportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } }, "name": { "description": "Unique name of the import-export file." } }, "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", "readOnly": true }, "mcpAllowlist": { "type": "object" }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "c78c7ea361b7def0876b75bd1bd37879" } } } } }, "type": "object" }, "aclRoles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "acl_role" }, "id": { "type": "string", "example": "e050a8081a3eb1d193c23cf0ef761183" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Integration": { "description": "Added since version: 6.0.0.0", "required": [ "id", "label", "accessKey", "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Integration." }, "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", "readOnly": true }, "mcpAllowlist": { "type": "object" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "deletedAt": { "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "createdNotifications": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "app": { "$ref": "#/components/schemas/App" }, "stateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "aclRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } }, "writeAccess": { "description": "This field is deprecated." }, "integrationId": { "description": "Unique identity of integration" }, "aclRoleId": { "description": "Unique identity of ACL role." } }, "type": "object" }, "IntegrationRole": { "description": "Added since version: 6.3.3.0", "required": [ "integrationId", "aclRoleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Integration role." }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integration": { "$ref": "#/components/schemas/Integration" }, "role": { "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, "LandingPageJsonApi": { "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "keywords": { "type": "string" }, "url": { "type": "string" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "cmsPage": { "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "seoUrls": { "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "seo_url" }, "id": { "type": "string", "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "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}$", "description": "Unique identity of landing page." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of landing page version." }, "active": { "type": "boolean", "description": "When boolean value is `true`, respective landing pages are enlisted for use." }, "name": { "type": "string", "description": "Name of landing page." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "slotConfig": { "type": "object", "description": "Specifies detailed information about how the CMS slots are configured for landing page." }, "metaTitle": { "type": "string", "description": "A page title indexed by search engines and appears in search results listings." }, "metaDescription": { "type": "string", "description": "A short description of the page for search results listings." }, "keywords": { "type": "string", "description": "The keywords that help to search the landing page." }, "url": { "type": "string", "description": "URL of the landing page." }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the CMS Page." }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the CMS Page's version." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { "$ref": "#/components/schemas/CmsPage", "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "seoUrls": { "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } }, "type": "object" }, "LandingPageSalesChannel": { "description": "Added since version: 6.4.0.0", "required": [ "landingPageId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the landing page sales channel." }, "landingPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the landing page." }, "landingPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the landing pages's version." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the sales channel." }, "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}$", "description": "Unique identity of the landing page tag." }, "landingPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the landing page." }, "landingPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the landing pages's version." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the tag." }, "landingPage": { "$ref": "#/components/schemas/LandingPage" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "LanguageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "localeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the language.", "type": "string" }, "active": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "parent": { "description": "Unique identity of language.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "locale": { "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, "translationCode": { "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" } } } }, "type": "object" }, "children": { "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "salesChannelDomains": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } } }, "type": "object" }, "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "productSearchKeywords": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_keyword" }, "id": { "type": "string", "example": "ea9cb6522f347c9212c9459d63c645f4" } } } } }, "type": "object" }, "productKeywordDictionaries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_keyword_dictionary" }, "id": { "type": "string", "example": "660e189a383ca4eb148e25eb0df85988" } } } } }, "type": "object" }, "productReviews": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review" }, "id": { "type": "string", "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" }, "productSearchConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8d4fbbaa71409309d308e57678de7d7a" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Language": { "description": "Added since version: 6.0.0.0", "required": [ "id", "localeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of language." }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent language." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "parent": { "$ref": "#/components/schemas/Language", "description": "Unique identity of language." }, "locale": { "$ref": "#/components/schemas/Locale", "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { "$ref": "#/components/schemas/Locale", "description": "Locale used for translating content" }, "children": { "description": "Child languages inheriting from this parent language", "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannelDomains": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "productSearchKeywords": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchKeyword" } }, "productKeywordDictionaries": { "type": "array", "items": { "$ref": "#/components/schemas/ProductKeywordDictionary" } }, "productReviews": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "productSearchConfig": { "$ref": "#/components/schemas/ProductSearchConfig" } }, "type": "object" }, "LocaleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "code", "name", "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { "type": "string" }, "territory": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "languages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "example": "f3e334d42863e8250c7d03efefbfd387" } } } } }, "type": "object" }, "users": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "example": "9bc65c2abec141778ffaa729489f3e87" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Locale": { "description": "Added since version: 6.0.0.0", "required": [ "id", "code", "name", "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of locale." }, "code": { "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { "type": "string", "description": "Name of the locale. For example: English." }, "territory": { "type": "string", "description": "Name of the location. For example: Canada." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "type": "object" }, "LogEntryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "message": { "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, "channel": { "type": "string" }, "context": { "type": "object" }, "extra": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of log entry." }, "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", "description": "Information associated with a log entry." }, "extra": { "type": "object", "description": "Additional information associated with a log entry." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "MailHeaderFooterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "headerHtml": { "type": "string" }, "headerPlain": { "type": "string" }, "footerHtml": { "type": "string" }, "footerPlain": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of mail's header and footer component." }, "systemDefault": { "type": "boolean", "description": "Unused field. To be removed in future." }, "name": { "type": "string", "description": "Name of the MailHeaderFooter." }, "description": { "type": "string", "description": "Description of the MailHeaderFooter." }, "headerHtml": { "type": "string", "description": "HTML header content." }, "headerPlain": { "type": "string", "description": "Textual header content." }, "footerHtml": { "type": "string", "description": "HTML footer content." }, "footerPlain": { "type": "string", "description": "Textual footer content." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "MailTemplateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "mailTemplateTypeId", "subject", "contentHtml", "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailTemplateTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "wasModifiedByUser": { "type": "boolean" }, "senderName": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "contentHtml": { "type": "string" }, "contentPlain": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "mailTemplateType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template_media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ "id", "mailTemplateTypeId", "subject", "contentHtml", "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of mail template." }, "mailTemplateTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of mail template type." }, "systemDefault": { "type": "boolean", "description": "Unused field. To be removed in future." }, "wasModifiedByUser": { "type": "boolean" }, "senderName": { "type": "string", "description": "Name of the sender in the mail." }, "description": { "type": "string", "description": "A short description of defined mail template." }, "subject": { "type": "string", "description": "A headline of the email." }, "contentHtml": { "type": "string", "description": "HTML content in the mail." }, "contentPlain": { "type": "string", "description": "Textual content in the mail." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "mailTemplateType": { "$ref": "#/components/schemas/MailTemplateType" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateMedia" } } }, "type": "object" }, "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", "required": [ "id", "mailTemplateId", "languageId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of mail template's media." }, "mailTemplateId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the mail template." }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the language." }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the media." }, "position": { "type": "integer", "format": "int64", "description": "The order of multiple media templates defined is specified using numerical values like 1,2,3, etc." }, "mailTemplate": { "$ref": "#/components/schemas/MailTemplate" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "MailTemplateTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { "type": "object" }, "customFields": { "type": "object" }, "templateData": { "type": "object", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "mailTemplates": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template" }, "id": { "type": "string", "example": "e6f502f7d88de75db45325d22998cf6d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of mail template type." }, "name": { "type": "string", "description": "Name of the mail template." }, "technicalName": { "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { "type": "object", "description": "Defines which entities are compatible with a given mail template type, ensuring that the right templates can be used for the appropriate purposes within the system" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "templateData": { "type": "object", "deprecated": true, "description": "Template data used to generate emails associated with that template type." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "mailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } }, "type": "object" }, "MainCategoryJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "categoryId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "category": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c4ef352f74e502ef5e7bc98e6f4e493d" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MainCategory": { "description": "Added since version: 6.1.0.0", "required": [ "id", "productId", "categoryId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of main category." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "categoryId": { "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the category's version." }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "measurement_system" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c0484ac171c930ce54e78cd2e0d80e5a" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MeasurementDisplayUnit": { "description": "Added since version: 6.7.1.0", "required": [ "id", "measurementSystemId", "default", "type", "shortName", "factor", "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "default": { "type": "boolean" }, "type": { "type": "string" }, "shortName": { "type": "string" }, "factor": { "type": "number", "format": "float" }, "precision": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "measurementSystem": { "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, "MeasurementSystemJsonApi": { "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "units": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "measurement_display_unit" }, "id": { "type": "string", "example": "b98b3dfbd27e710e6c3ceeae58770b52" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MeasurementSystem": { "description": "Added since version: 6.7.1.0", "required": [ "id", "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "units": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementDisplayUnit" } } }, "type": "object" }, "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "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" } }, "type": "object" }, "relationships": { "properties": { "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "thumbnails": { "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "productManufacturers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_manufacturer" }, "id": { "type": "string", "example": "30e3a0f8868364c06aa4be63426c1c79" } } } } }, "type": "object" }, "productMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_media" }, "id": { "type": "string", "example": "2b5e079404830806ea36b6c17438cffd" } } } } }, "type": "object" }, "productDownloads": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_download" }, "id": { "type": "string", "example": "86db490c1f4f52d155dbdb978b1f45d3" } } } } }, "type": "object" }, "orderLineItemDownloads": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item_download" }, "id": { "type": "string", "example": "8c0a5ecd281c97a912c27c0237b3848f" } } } } }, "type": "object" }, "avatarUsers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "example": "1fc09529f6c95370eb20b81318ff601f" } } } } }, "type": "object" }, "mediaFolder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70605921a592ee735964394f7948773b" } } } }, "type": "object" }, "propertyGroupOptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "example": "789104e3568fde835b6239b251d4aa07" } } } } }, "type": "object" }, "mailTemplateMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template_media" }, "id": { "type": "string", "example": "9970132c8439a2e630b655812b031459" } } } } }, "type": "object" }, "documentBaseConfigs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config" }, "id": { "type": "string", "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "productConfiguratorSettings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_configurator_setting" }, "id": { "type": "string", "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" } } } } }, "type": "object" }, "productOpenGraphImages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "a067685a73a5308efd6117308e659025" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" }, "cmsBlocks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "example": "3636c4901eab836dfb837e1a9a37d3c0" } } } } }, "type": "object" }, "cmsSections": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_section" }, "id": { "type": "string", "example": "53be3cc1c4a8f41af67a90cf9fd09194" } } } } }, "type": "object" }, "cmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "example": "e676148cc6ffb82b89b3903ecaed2d16" } } } } }, "type": "object" }, "documents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "21f64da1e5792c8295b964d159a14491" } } } } }, "type": "object" }, "a11yDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "f6c460e0d75110fa1ec7529fe364dbb5" } } } } }, "type": "object" }, "appPaymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_payment_method" }, "id": { "type": "string", "example": "e53c737d351047e64a02b7a2a4caffe3" } } } } }, "type": "object" }, "appShippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_shipping_method" }, "id": { "type": "string", "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } } }, "type": "object" }, "documentFile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/documentFile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_file" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e6fc751fcb387f6f87970b7fed0b489f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Media": { "description": "Added since version: 6.0.0.0", "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the media." }, "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, "description": "Details of the media file uploaded." }, "mediaType": { "type": "object", "readOnly": true, "description": "Type or format of media content, such as images, videos, or audio files." }, "config": { "type": "object" }, "alt": { "type": "string", "description": "Alternate text for media." }, "title": { "type": "string", "description": "Title name give to the media." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "fileHash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "extensions": { "properties": { "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" }, "themeMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "260be9ecb281c4ff04e7189bb18a35bd" } } } } }, "type": "object" } }, "type": "object", "description": "To store additional data to a media from extensions." }, "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" } }, "productOpenGraphImages": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "orderLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "cmsBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } }, "cmsSections": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "cmsPages": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "a11yDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "appPaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "appShippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } }, "documentFile": { "$ref": "#/components/schemas/DocumentFile" } }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": [ "id", "entity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media default folder." }, "entity": { "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "defaultFolder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_default_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "251dcc9b1621d34e6b01ee14c26b3027" } } } }, "type": "object" }, "configuration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder_configuration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ccd1066343c95877b75b79d47c36bebe" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": [ "id", "configurationId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media folder." }, "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}$", "description": "Unique identity of parent." }, "childCount": { "type": "integer", "format": "int64", "readOnly": true, "description": "Number of media within the media folder." }, "path": { "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { "description": "Name of media folder.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "parent": { "$ref": "#/components/schemas/MediaFolder", "description": "Unique identity of media folder." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "defaultFolder": { "$ref": "#/components/schemas/MediaDefaultFolder" }, "configuration": { "$ref": "#/components/schemas/MediaFolderConfiguration" } }, "type": "object" }, "MediaFolderConfigurationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "mediaFolders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "example": "6e8238687513bde2e85821c839c597c6" } } } } }, "type": "object" }, "mediaThumbnailSizes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_thumbnail_size" }, "id": { "type": "string", "example": "44dee48a0006e8db2fcec2a5e1456449" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media folder configuration." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "mediaFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } }, "mediaThumbnailSizes": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } }, "type": "object" }, "MediaFolderConfigurationMediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ "mediaFolderConfigurationId", "mediaThumbnailSizeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderConfigurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderConfiguration": { "$ref": "#/components/schemas/MediaFolderConfiguration" }, "mediaThumbnailSize": { "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" }, "MediaTag": { "description": "Added since version: 6.0.0.0", "required": [ "mediaId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the media tag." }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the media." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the tag." }, "media": { "$ref": "#/components/schemas/Media" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "MediaThumbnailJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "mediaId", "width", "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "mediaThumbnailSize": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_thumbnail_size" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0d0b8659a3a47e9d7e1481961f127fd0" } } } }, "type": "object" } }, "type": "object" } }, "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}$", "description": "Unique identity of media thumbnail." }, "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.", "type": "string" }, "path": { "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder_configuration" }, "id": { "type": "string", "example": "056df7a700173d83ebb685b1a890f09b" } } } } }, "type": "object" }, "mediaThumbnails": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_thumbnail" }, "id": { "type": "string", "example": "76ebc340ac8f9754c760c3ec742d2407" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ "id", "width", "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media thumbnail size defined." }, "width": { "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "mediaFolderConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } }, "mediaThumbnails": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } } }, "type": "object" }, "NewsletterRecipientJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "email", "status", "hash", "languageId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "description": "Email of the recipient.", "type": "string" }, "title": { "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { "description": "First name of the recipient.", "type": "string" }, "lastName": { "description": "Last name of the recipient.", "type": "string" }, "zipCode": { "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { "description": "City of the recipient.", "type": "string" }, "street": { "description": "Street of the recipient.", "type": "string" }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string", "enum": [ "notSet", "optIn", "optOut", "direct" ] }, "hash": { "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ "id", "email", "status", "hash", "languageId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of newsletter recipient." }, "email": { "description": "Email of the recipient.", "type": "string" }, "title": { "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { "description": "First name of the recipient.", "type": "string" }, "lastName": { "description": "Last name of the recipient.", "type": "string" }, "zipCode": { "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { "description": "City of the recipient.", "type": "string" }, "street": { "description": "Street of the recipient.", "type": "string" }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string", "enum": [ "notSet", "optIn", "optOut", "direct" ] }, "hash": { "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "confirmedAt": { "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "salutation": { "$ref": "#/components/schemas/Salutation" }, "language": { "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "NewsletterRecipientTag": { "description": "Added since version: 6.0.0.0", "required": [ "newsletterRecipientId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the sales channel." }, "newsletterRecipientId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the newsletter recipient." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the tag." }, "newsletterRecipient": { "$ref": "#/components/schemas/NewsletterRecipient" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "NotificationJsonApi": { "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "status", "message" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "status": { "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdByIntegrationId": { "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "createdByIntegration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "4698501400b26be8a41def09646e1b59" } } } }, "type": "object" }, "createdByUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8a66af2fd5b68899934d19e078c9c111" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Notification": { "description": "Added since version: 6.4.7.0", "required": [ "id", "status", "message" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of notification." }, "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 }, "description": "Parameter within a notification configuration that specifies the required user privileges or permissions to access or view a particular notification." }, "createdByIntegrationId": { "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "createdByIntegration": { "$ref": "#/components/schemas/Integration" }, "createdByUser": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "NumberRangeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "typeId", "global", "pattern", "start", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "typeId": { "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "pattern": { "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "type": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, "numberRangeSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_sales_channel" }, "id": { "type": "string", "example": "62db021f1d56ae4688775365be68a04f" } } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ "id", "typeId", "global", "pattern", "start", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of number range." }, "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": "Name of the number range." }, "description": { "type": "string", "description": "A short description of number range." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "numberRangeType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3d771a402fc5aa3349c2c15637058e8c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", "numberRangeId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Sales channels's number rage." }, "numberRangeId": { "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "numberRange": { "$ref": "#/components/schemas/NumberRange" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "numberRangeType": { "$ref": "#/components/schemas/NumberRangeType" } }, "type": "object" }, "NumberRangeStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "numberRangeId", "lastValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastValue": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "numberRange": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRangeState": { "description": "Added since version: 6.0.0.0", "required": [ "id", "numberRangeId", "lastValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of number range's state." }, "numberRangeId": { "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastValue": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "numberRange": { "$ref": "#/components/schemas/NumberRange" } }, "type": "object" }, "NumberRangeTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "global", "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "numberRanges": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "example": "d28d88efea70a67487116019cff39002" } } } } }, "type": "object" }, "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}$", "description": "Unique identity of number range's type." }, "technicalName": { "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string", "description": "Name of the type." }, "global": { "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "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": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "shippingTotal": { "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { "description": "Comments given by comments.", "type": "string" }, "internalComment": { "type": "string" }, "source": { "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdById": { "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "salesChannelTracking": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "stateMachineState": { "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "primaryOrderDelivery": { "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fdeeebdae32b4dfa39d3f4372d0554e9" } } } }, "type": "object" }, "primaryOrderTransaction": { "description": "Primary payment transaction for the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bbaa9e50388c524d97853a4fc4476b0e" } } } }, "type": "object" }, "orderCustomer": { "description": "Customer information associated with the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e90c9c228c1510f5a25902f7a1e8426a" } } } }, "type": "object" }, "currency": { "description": "Currency used for the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "language": { "description": "Language used when placing the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "addresses": { "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "963e3a2fe559e393bad631f3dc686f69" } } } } }, "type": "object" }, "billingAddress": { "description": "Billing address for the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" }, "deliveries": { "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "6fc31b6b9cd717cc0dcb81152308f8af" } } } } }, "type": "object" }, "lineItems": { "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" }, "transactions": { "description": "Payment transactions for the order", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "example": "c15b977dd99332ca8623fbdfb86827e8" } } } } }, "type": "object" }, "documents": { "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "21f64da1e5792c8295b964d159a14491" } } } } }, "type": "object" }, "tags": { "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Order": { "description": "Added since version: 6.0.0.0", "required": [ "id", "billingAddressId", "currencyId", "languageId", "salesChannelId", "orderDateTime", "currencyFactor", "stateId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order version." }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true, "description": "Internal field." }, "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}$", "description": "Unique identity of the billing address version." }, "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "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", "description": "Net price of the product." }, "totalPrice": { "type": "number", "format": "float", "description": "Gross price of the product." }, "calculatedTaxes": { "type": "object", "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "type": "object", "description": "Pricing based on multiple taxes." }, "positionPrice": { "type": "number", "format": "float", "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc." }, "rawTotal": { "type": "number", "format": "float", "description": "The total value before rounding off." }, "taxStatus": { "type": "string", "description": "TaxStatus takes `Free`, `Net` or `Gross` as values." } }, "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", "description": "Shipping cost of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Shipping cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "calculatedTaxes": { "type": "object", "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "type": "object", "description": "Pricing based on multiple taxes." }, "referencePrice": { "type": "object", "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Price of each line item." }, "discount": { "type": "number", "format": "float", "description": "Absolute discount on each line item." }, "percentage": { "type": "number", "format": "float", "description": "Discount in percentage." } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Contains cheapest price from last 30 days as per EU law." } }, "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" }, "description": "Unique identity of rule." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdById": { "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on net prices." } }, "type": "object" }, "totalRounding": { "required": [ "decimals", "interval", "roundForNet" ], "properties": { "decimals": { "type": "integer", "format": "int64", "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "type": "number", "format": "float", "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "type": "boolean", "description": "The cash rounding applied on net prices." } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "salesChannelTracking": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" } }, "type": "object" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, "primaryOrderDelivery": { "$ref": "#/components/schemas/OrderDelivery", "description": "Primary delivery information for the order" }, "primaryOrderTransaction": { "$ref": "#/components/schemas/OrderTransaction", "description": "Primary payment transaction for the order" }, "orderCustomer": { "$ref": "#/components/schemas/OrderCustomer", "description": "Customer information associated with the order" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "Currency used for the order" }, "language": { "$ref": "#/components/schemas/Language", "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "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/OrderLineItem" } }, "transactions": { "description": "Payment transactions for the order", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "documents": { "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "tags": { "description": "Tags assigned to the order for organization and filtering", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "OrderAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "countryId", "orderId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "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" }, "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", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "countryState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "orderDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "0ba472de56dd7ba2e7bb878434321e26" } } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", "countryId", "orderId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order's address." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderAddresses version." }, "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}$", "description": "Unique identity of order's version." }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "street": { "description": "Street address", "type": "string" }, "zipcode": { "description": "Zip code of the country.", "type": "string" }, "city": { "description": "Name of the city.", "type": "string" }, "company": { "description": "Name of the company.", "type": "string" }, "department": { "description": "Name of the department.", "type": "string" }, "title": { "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { "description": "Additional address input if necessary.", "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "vatId": { "description": "Unique identity of VAT.", "type": "string", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "order": { "$ref": "#/components/schemas/Order" }, "orderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "OrderCustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "email", "firstName", "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "description": "Email address of the customer.", "type": "string" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "company": { "description": "Name of the company.", "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", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", "email", "firstName", "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order customer." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderCustomer's version." }, "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}$", "description": "Unique identity of order's version." }, "email": { "description": "Email address of the customer.", "type": "string" }, "salutationId": { "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "description": "First name of the customer.", "type": "string" }, "lastName": { "description": "Last name of the customer.", "type": "string" }, "company": { "description": "Name of the company.", "type": "string" }, "title": { "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { "type": "array", "items": { "type": "string" }, "description": "Unique identity of VAT." }, "customerNumber": { "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "remoteAddress": { "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "customer": { "$ref": "#/components/schemas/Customer" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "OrderDeliveryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "shippingOrderAddressId", "shippingMethodId", "stateId", "shippingDateEarliest", "shippingDateLatest" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingCodes": { "type": "array", "items": { "type": "string" } }, "shippingDateEarliest": { "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, "shippingCosts": { "required": [ "unitPrice", "totalPrice", "quantity" ], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "shippingOrderAddress": { "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" } } } }, "type": "object" }, "positions": { "description": "Line items included in this delivery", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery_position" }, "id": { "type": "string", "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" }, "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" } }, "type": "object" } ] }, "OrderDelivery": { "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", "shippingOrderAddressId", "shippingMethodId", "stateId", "shippingDateEarliest", "shippingDateLatest" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Order's delivery." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderDelivery's version." }, "orderId": { "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order's version." }, "shippingOrderAddressId": { "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order's shipping address version." }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingCodes": { "type": "array", "items": { "type": "string" }, "description": "Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel." }, "shippingDateEarliest": { "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "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", "description": "Shipping cost of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Shipping cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "calculatedTaxes": { "type": "object", "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "type": "object", "description": "Pricing based on multiple taxes." }, "referencePrice": { "type": "object", "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Price of each line item." }, "discount": { "type": "number", "format": "float", "description": "Absolute discount on each line item." }, "percentage": { "type": "number", "format": "float", "description": "Discount in percentage." } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Contains cheapest price from last 30 days as per EU law." } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { "$ref": "#/components/schemas/OrderAddress", "description": "Shipping address for this delivery" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod", "description": "Shipping method used for this delivery" }, "positions": { "description": "Line items included in this delivery", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } }, "primaryOrder": { "$ref": "#/components/schemas/Order" } }, "type": "object" }, "OrderDeliveryPositionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderDeliveryId", "orderLineItemId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": [ "unitPrice", "totalPrice", "quantity" ], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "unitPrice": { "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { "description": "Number of items of each product.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderDelivery": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "473c50bdac32ac0dc66364d121260dce" } } } }, "type": "object" }, "orderLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ "id", "orderDeliveryId", "orderLineItemId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order delivery position." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderDeliveryPosition's version." }, "orderDeliveryId": { "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order delivery's version." }, "orderLineItemId": { "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of line item's version in an order." }, "price": { "required": [ "unitPrice", "totalPrice", "quantity" ], "properties": { "unitPrice": { "type": "number", "format": "float", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "calculatedTaxes": { "type": "object", "description": "Contains calculated taxes based on order delivery price." }, "taxRules": { "type": "object", "description": "Pricing based on multiple taxes." }, "referencePrice": { "type": "object", "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Price of each line item." }, "discount": { "type": "number", "format": "float", "description": "Absolute discount on each line item." }, "percentage": { "type": "number", "format": "float", "description": "Discount in percentage." } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Contains cheapest price from last 30 days as per EU law." } }, "type": "object" } }, "type": "object" }, "unitPrice": { "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { "description": "Number of items of each product.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderDelivery": { "$ref": "#/components/schemas/OrderDelivery" }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, "OrderLineItemJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "identifier", "quantity", "label", "price", "children", "states" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, "price": { "required": [ "unitPrice", "totalPrice", "quantity" ], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "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 }, "relationships": { "properties": { "cover": { "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "product": { "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "orderDeliveryPositions": { "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery_position" }, "id": { "type": "string", "example": "76d4619a36f864b08f57415baaa685ec" } } } } }, "type": "object" }, "orderTransactionCaptureRefundPositions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", "example": "c330b64e5adc1e48e07a78aa79e5b27a" } } } } }, "type": "object" }, "downloads": { "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item_download" }, "id": { "type": "string", "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "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}$", "description": "Unique identity of OrderLineItem." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderLineItem's version." }, "orderId": { "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order's version." }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of products's version." }, "promotionId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent product." }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent's version." }, "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", "description": "Any data related to product is passed." }, "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", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "calculatedTaxes": { "type": "object", "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "type": "object", "description": "Pricing based on multiple taxes." }, "referencePrice": { "type": "object", "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Price of each line item." }, "discount": { "type": "number", "format": "float", "description": "Absolute discount on each line item." }, "percentage": { "type": "number", "format": "float", "description": "Discount in percentage." } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float", "description": "Contains cheapest price from last 30 days as per EU law." } }, "type": "object" } }, "type": "object" }, "priceDefinition": { "type": "object", "description": "Description of how the price has to be calculated. For example, in percentage or absolute value, etc." }, "unitPrice": { "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "states": { "type": "array", "items": { "type": "string" }, "deprecated": true, "description": "Internal field." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "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": { "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}$", "description": "Unique identity of Order line item downloaded digital products." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Order line item downloaded version." }, "orderLineItemId": { "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Order line item's version." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "OrderTag": { "description": "Added since version: 6.0.0.0", "required": [ "orderId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order tag." }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order." }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order's version." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag given for an order." }, "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" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "validationData": { "type": "object" }, "stateId": { "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "paymentMethod": { "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "captures": { "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture" }, "id": { "type": "string", "example": "8856ffdd044d57cd4124a6be5dcea329" } } } } }, "type": "object" }, "primaryOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f3654baea1bb37cbbd3b86e9793c3766" } } } }, "type": "object" } }, "type": "object" } }, "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}$", "description": "Unique identity of order transaction." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of OrderTransaction's version." }, "orderId": { "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of an order's version." }, "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", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "validationData": { "type": "object" }, "stateId": { "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "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" }, "shippingCosts": { "properties": { "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "description": "Price of each line item." }, "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } } }, "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": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "transaction": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, "refunds": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "example": "0084ff716402199f733f841f5937d3ae" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCapture": { "description": "Added since version: 6.4.12.0", "required": [ "id", "orderTransactionId", "stateId", "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture's version." }, "orderTransactionId": { "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction version." }, "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", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "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" } }, "shippingCosts": { "properties": { "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "description": "Price of each line item." }, "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } } }, "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", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "transactionCapture": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56b70ce76ce8e9bfbaf80ea040d456b5" } } } }, "type": "object" }, "positions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCaptureRefund": { "description": "Added since version: 6.4.12.0", "required": [ "id", "captureId", "stateId", "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture refund." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture refund's version." }, "captureId": { "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "captureVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture's version." }, "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", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "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" } }, "shippingCosts": { "properties": { "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "description": "Price of each line item." }, "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } } }, "type": "object" }, "OrderTransactionCaptureRefundPositionJsonApi": { "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "refundId", "orderLineItemId", "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundId": { "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "description": "External payment provider token.", "type": "string" }, "reason": { "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, "amount": { "required": [ "unitPrice", "totalPrice", "quantity" ], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8e55f83da36c39263717541ec1f18de7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCaptureRefundPosition": { "description": "Added since version: 6.4.12.0", "required": [ "id", "refundId", "orderLineItemId", "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture refund position." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture refund position's version." }, "refundId": { "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order transaction capture refund's version." }, "orderLineItemId": { "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of order line item version." }, "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", "description": "Price of product per item (where, quantity=1)." }, "totalPrice": { "type": "number", "format": "float", "description": "Cost of product based on quantity." }, "quantity": { "type": "integer", "format": "int64", "description": "Number of items of each product." }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "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" }, "shippingCosts": { "properties": { "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "description": "Price of each line item." }, "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } } }, "type": "object" }, "PaymentMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { "type": "string" }, "distinguishableName": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "position": { "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "formattedHandlerIdentifier": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "technicalName": { "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "media": { "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "availabilityRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "plugin": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "plugin" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a24bcf2198b1b13ad985304483f7f324" } } } }, "type": "object" }, "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "orderTransactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "appPaymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of payment method." }, "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", "description": "Name of the payment method." }, "distinguishableName": { "type": "string", "readOnly": true, "description": "System identifier name for payment method." }, "description": { "type": "string", "description": "A short description about the payment method." }, "position": { "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "availabilityRuleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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", "description": "Contains the translations of all translated fields." }, "media": { "$ref": "#/components/schemas/Media", "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "plugin": { "$ref": "#/components/schemas/Plugin" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orderTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "appPaymentMethod": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "type": "object" }, "PluginJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "baseClass", "name", "autoload", "version", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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}$", "description": "Unique identity of a plugin." }, "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", "description": "This ensures to automatically load all class files of a project before using them." }, "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": "Label given to a plugin." }, "description": { "type": "string", "description": "A short description about the plugin." }, "manufacturerLink": { "type": "string", "description": "Links to the manufacturer page" }, "supportLink": { "type": "string", "description": "Links to the support page" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "changelog": { "description": "Deprecated from Shopware version 6.6" } }, "type": "object" }, "ProductJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "taxId", "price", "productNumber", "stock", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { "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}$" }, "openGraphMediaId": { "description": "Media used as Open Graph image for social media sharing.", "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 } }, "ogTitle": { "type": "string" }, "ogDescription": { "type": "string" }, "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", "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)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/downloads" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_download" }, "id": { "type": "string", "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } } }, "type": "object" }, "parent": { "description": "Unique identity of the product.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "deliveryTime": { "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "delivery_time" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, "tax": { "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/tax" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, "manufacturer": { "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/manufacturer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_manufacturer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c2904bca62b22443d6cf5e9d89cab204" } } } }, "type": "object" }, "unit": { "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/unit" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "unit" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3e34bdebd9bd5edda27e8728904a2552" } } } }, "type": "object" }, "cover": { "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/cover" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, "openGraphMedia": { "description": "Open Graph image for social media sharing", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bbda52d941a3452369a00f2880f4f358" } } } }, "type": "object" }, "featureSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/featureSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_feature_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" } } } }, "type": "object" }, "cmsPage": { "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, "canonicalProduct": { "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "023995a50b56c0de077323e958b2bbcd" } } } }, "type": "object" }, "prices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/prices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_price" }, "id": { "type": "string", "example": "afae32efe0f84fece3f96b377b768b33" } } } } }, "type": "object" }, "media": { "description": "Product images and media gallery", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "crossSellings": { "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/crossSellings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling" }, "id": { "type": "string", "example": "89936e14544d1b403cecef938101b6b0" } } } } }, "type": "object" }, "crossSellingAssignedProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling_assigned_products" }, "id": { "type": "string", "example": "5ee26b69e515f51ece26912961283b6d" } } } } }, "type": "object" }, "configuratorSettings": { "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_configurator_setting" }, "id": { "type": "string", "example": "c0827fee13725d41f1fd7e292243f5aa" } } } } }, "type": "object" }, "visibilities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/visibilities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_visibility" }, "id": { "type": "string", "example": "63226fcdfe3316ec1237ef07a8fe6732" } } } } }, "type": "object" }, "searchKeywords": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_keyword" }, "id": { "type": "string", "example": "effbcffaacb8111b531f15e6f4c796d1" } } } } }, "type": "object" }, "productReviews": { "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/productReviews" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review" }, "id": { "type": "string", "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" }, "mainCategories": { "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/mainCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "main_category" }, "id": { "type": "string", "example": "1fb731fc4139cbb575429e28846f0c39" } } } } }, "type": "object" }, "seoUrls": { "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/seoUrls" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "seo_url" }, "id": { "type": "string", "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" }, "wishlists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/wishlists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist_product" }, "id": { "type": "string", "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } } }, "type": "object" }, "options": { "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/options" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "example": "93da65a9fd0004d9477aeac024e08e15" } } } } }, "type": "object" }, "properties": { "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/properties" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "example": "74693d2fc58b46bd06410f278e39aa71" } } } } }, "type": "object" }, "categories": { "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "streams": { "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/streams" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "example": "2f6f4768f1c2d7c8f1f54823723f1a70" } } } } }, "type": "object" }, "categoriesRo": { "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "7f0702d3a90d965b8c9158c451f43fdb" } } } } }, "type": "object" }, "tags": { "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "customFieldSets": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "example": "9b29ba872ce510f033b31364c8602760" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Product": { "description": "Added since version: 6.0.0.0", "required": [ "id", "taxId", "price", "productNumber", "stock", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the parent product." }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the parent product's version." }, "manufacturerId": { "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productManufacturerVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's manufacturer version." }, "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}$", "description": "Unique identity of product's media version." }, "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}$", "description": "Unique identity of CMS page's version." }, "openGraphMediaId": { "description": "Media used as Open Graph image for social media sharing.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" }, "description": "Price of the product." }, "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, "description": "Internal field." }, "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" }, "description": "Internal field." }, "displayGroup": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "variantListingConfig": { "type": "object", "description": "Information regarding if this variant should included in listing or not." }, "variantRestrictions": { "type": "object", "description": "Configuration about which variants and its combination are not available like red shirt in medium size in not available." }, "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" }, "description": "Actual/cost price of the product." }, "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, "description": "Internal field." }, "propertyIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of property." }, "optionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of options." }, "streamIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of stream." }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of tags." }, "categoryIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of category." }, "childCount": { "type": "integer", "format": "int64", "readOnly": true, "description": "Number of variants the product has." }, "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", "description": "A short description of the product for search results listings." }, "name": { "type": "string", "description": "Name of the product." }, "keywords": { "type": "string", "description": "Keywords that give additional information about the Product." }, "description": { "type": "string", "description": "Description of the product." }, "metaTitle": { "type": "string", "description": "A page title indexed by search engines and appears in search results listings." }, "packUnit": { "type": "string", "description": "Type of packing. For example, bottle, tin, crate, etc." }, "packUnitPlural": { "type": "string", "description": "Type of packing in plural. For example, bottles, tins, crates, etc." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "slotConfig": { "type": "object", "description": "Specifies detailed information about how the CMS slots are configured for products." }, "customSearchKeywords": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "List of additional keywords in the search." }, "ogTitle": { "type": "string" }, "ogDescription": { "type": "string" }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", "enum": [ "physical", "digital" ] }, "states": { "type": "array", "items": { "type": "string" }, "readOnly": true, "deprecated": true, "description": "Internal field." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "downloads": { "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { "$ref": "#/components/schemas/Product", "description": "Unique identity of the product." }, "children": { "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { "$ref": "#/components/schemas/DeliveryTime", "description": "Estimated delivery time for the product" }, "tax": { "$ref": "#/components/schemas/Tax", "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { "$ref": "#/components/schemas/ProductManufacturer", "description": "Product manufacturer or brand information" }, "unit": { "$ref": "#/components/schemas/Unit", "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, "openGraphMedia": { "$ref": "#/components/schemas/Media", "description": "Open Graph image for social media sharing" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { "$ref": "#/components/schemas/CmsPage", "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { "$ref": "#/components/schemas/Product", "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/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" } }, "categories": { "description": "Categories this product is assigned to", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "streams": { "description": "Dynamic product streams this product belongs to based on defined filters", "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } }, "categoriesRo": { "description": "Read-only category tree including all parent categories for optimized queries", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "tags": { "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "customFieldSets": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } } }, "type": "object" }, "ProductCategory": { "description": "Added since version: 6.0.0.0", "required": [ "productId", "categoryId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Category." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Category." }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Category's version." }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" } }, "type": "object" }, "ProductCategoryTree": { "description": "Added since version: 6.0.0.0", "required": [ "productId", "categoryId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Category." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Category." }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Category's version." }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" } }, "type": "object" }, "ProductConfiguratorSettingJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "optionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, "position": { "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "option": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/option" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ef3e30e070f70244fd6578d88a6b77ac" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "optionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product configurator setting." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product configurator setting version." }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product version." }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object", "description": "Price of the Product." }, "position": { "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductCrossSellingJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "productId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "assignedProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling_assigned_products" }, "id": { "type": "string", "example": "5da5e10eda1b7026499bcd4747d6bdf8" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductCrossSelling": { "description": "Added since version: 6.1.0.0", "required": [ "id", "name", "productId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product cross selling." }, "name": { "type": "string", "description": "Name defined for Product cross selling." }, "position": { "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product's version." }, "productStreamId": { "description": "Unique identity of product stream.", "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", "description": "Contains the translations of all translated fields." }, "product": { "$ref": "#/components/schemas/Product" }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "assignedProducts": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } }, "type": "object" }, "ProductCrossSellingAssignedProductsJsonApi": { "description": "Added since version: 6.2.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "crossSellingId", "productId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "crossSelling": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ef23268669fb6d8a7def2b9f2da0aceb" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductCrossSellingAssignedProducts": { "description": "Added since version: 6.2.0.0", "required": [ "id", "crossSellingId", "productId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product CrossSelling Assigned Products." }, "crossSellingId": { "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "position": { "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "crossSelling": { "$ref": "#/components/schemas/ProductCrossSelling" } }, "type": "object" }, "ProductCustomFieldSet": { "description": "Added since version: 6.3.0.0", "required": [ "productId", "customFieldSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Custom Field Set." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product." }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of custom Field Set." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "product": { "$ref": "#/components/schemas/Product" }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, "ProductDownloadJsonApi": { "description": "Added since version: 6.4.19.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductDownload": { "description": "Added since version: 6.4.19.0", "required": [ "id", "productId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity downloaded product." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of downloaded product's version." }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product version." }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "ProductExportJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", "salesChannelDomainId", "currencyId", "fileName", "accessKey", "encoding", "fileFormat", "generateByCronjob", "interval" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { "description": "Name of the file.", "type": "string" }, "accessKey": { "description": "Access key to admin api.", "type": "string" }, "encoding": { "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "provider": { "description": "Selected export provider identifier, for example open-ai or google.", "type": "string" }, "feedLabel": { "description": "Optional feed label for grouping products within the same data source in Google Merchant Center. Uppercase letters (A-Z), numbers (0-9), hyphens (-), and underscores (_) are allowed, with a maximum length of 20 characters.", "type": "string" }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "storefrontSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/storefrontSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5979d6e259ba5ec4c2b93cf79df6f2e5" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "salesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannelDomain" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "29c8b34b04e94e35e95e8346954b7fb4" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductExport": { "description": "Added since version: 6.1.0.0", "required": [ "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", "salesChannelDomainId", "currencyId", "fileName", "accessKey", "encoding", "fileFormat", "generateByCronjob", "interval" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Exported Product." }, "productStreamId": { "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { "description": "Name of the file.", "type": "string" }, "accessKey": { "description": "Access key to admin api.", "type": "string" }, "encoding": { "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "provider": { "description": "Selected export provider identifier, for example open-ai or google.", "type": "string" }, "feedLabel": { "description": "Optional feed label for grouping products within the same data source in Google Merchant Center. Uppercase letters (A-Z), numbers (0-9), hyphens (-), and underscores (_) are allowed, with a maximum length of 20 characters.", "type": "string" }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "storefrontSalesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "salesChannelDomain": { "$ref": "#/components/schemas/SalesChannelDomain" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "ProductFeatureSetJsonApi": { "description": "Added since version: 6.3.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-feature-set/69d445ae065ef917cd50febab4b55db2/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductFeatureSet": { "description": "Added since version: 6.3.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product feature set." }, "name": { "type": "string", "description": "Name of product feature set." }, "description": { "type": "string", "description": "A short description of product feature set." }, "features": { "type": "object", "description": "The actual product features." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductKeywordDictionaryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "languageId", "keyword" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-keyword-dictionary/a1bc4695aa3e6f80fb42d62e6439296c/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductKeywordDictionary": { "description": "Added since version: 6.0.0.0", "required": [ "id", "languageId", "keyword" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product keyword." }, "languageId": { "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { "description": "The keywords are revered for the search.", "type": "string" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductManufacturerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "link": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductManufacturer": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the Product Manufacturer." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the ProductManufacturer's version." }, "mediaId": { "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "link": { "type": "string", "description": "URL of the manufacturer's portal." }, "name": { "type": "string", "description": "Name of the product manufacturer." }, "description": { "type": "string", "description": "A detailed description of product manufacturer." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "media": { "$ref": "#/components/schemas/Media" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductMediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "coverProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductMedia": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the Product Media." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the ProductMedia version." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "mediaId": { "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" }, "coverProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductOption": { "description": "Added since version: 6.0.0.0", "required": [ "productId", "optionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's price." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the option." }, "product": { "$ref": "#/components/schemas/Product" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductPriceJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "ruleId", "price", "quantityStart" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "customFields": { "type": "object" }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductPrice": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "ruleId", "price", "quantityStart" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's price." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product price's version." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "ruleId": { "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" }, "description": "Price of the Product." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "ProductProperty": { "description": "Added since version: 6.0.0.0", "required": [ "productId", "optionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product property." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the option." }, "product": { "$ref": "#/components/schemas/Product" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductReviewJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "salesChannelId", "languageId", "title", "content" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { "description": "External user name.", "type": "string" }, "externalEmail": { "description": "External user email address.", "type": "string" }, "title": { "description": "Title of product review.", "type": "string" }, "content": { "description": "Short description or subject of the project review.", "type": "string" }, "points": { "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { "description": "Detailed review about the product.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductReview": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "salesChannelId", "languageId", "title", "content" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's review." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "customerId": { "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { "description": "External user name.", "type": "string" }, "externalEmail": { "description": "External user email address.", "type": "string" }, "title": { "description": "Title of product review.", "type": "string" }, "content": { "description": "Short description or subject of the project review.", "type": "string" }, "points": { "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { "description": "Detailed review about the product.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "customer": { "$ref": "#/components/schemas/Customer" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductSearchConfigJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "languageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, "excludedTerms": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "configFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config_field" }, "id": { "type": "string", "example": "5334117da647d3f2fb8a82948d56bcc3" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchConfig": { "description": "Added since version: 6.3.5.0", "required": [ "id", "languageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Search Configuration." }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, "excludedTerms": { "type": "array", "items": { "type": "string" }, "description": "Excluded terms in product search." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" }, "configFields": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } }, "type": "object" }, "ProductSearchConfigFieldJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "searchConfigId", "field" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { "description": "Configuration of search field.", "type": "string" }, "tokenize": { "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "useExactSubfield": { "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", "type": "boolean" }, "ranking": { "description": "Search ranking.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "searchConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bc8281d44069ce8ffd34144fbad1bddd" } } } }, "type": "object" }, "customField": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ed2028a1c479c7e0065da597452d9c11" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchConfigField": { "description": "Added since version: 6.3.5.0", "required": [ "id", "searchConfigId", "field" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Search Configuration field." }, "searchConfigId": { "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { "description": "Configuration of search field.", "type": "string" }, "tokenize": { "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "useExactSubfield": { "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", "type": "boolean" }, "ranking": { "description": "Search ranking.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "searchConfig": { "$ref": "#/components/schemas/ProductSearchConfig" }, "customField": { "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, "ProductSearchKeywordJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "languageId", "productId", "keyword", "ranking" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { "description": "Search ranking.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", "required": [ "id", "languageId", "productId", "keyword", "ranking" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product Search Keyword." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ProductSearchKeyword's version." }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "keyword": { "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { "description": "Search ranking.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductSortingJsonApi": { "description": "Added since version: 6.3.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "key", "priority", "active", "fields", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "locked": { "type": "boolean" }, "key": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "fields": { "type": "object" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" } ] }, "ProductSorting": { "description": "Added since version: 6.3.2.0", "required": [ "id", "key", "priority", "active", "fields", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product sorting." }, "locked": { "type": "boolean", "description": "When locked, then ProductSorting cannot be configured." }, "key": { "type": "string", "description": "A keyword associated to identify product sorting." }, "priority": { "type": "integer", "format": "int64", "description": "A numerical value to prioritize the product sorting." }, "active": { "type": "boolean", "description": "When boolean value is `true`, the product sorting is enabled." }, "fields": { "type": "object", "description": "Fields used to sort products." }, "label": { "type": "string", "description": "Label given to a product sorting." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." } }, "type": "object" }, "ProductStreamJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "apiFilter": { "type": "object", "readOnly": true }, "invalid": { "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "internal": { "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "filters": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "example": "2c9885d2b0c7e26971f60a90f33cf718" } } } } }, "type": "object" }, "productCrossSellings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productCrossSellings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling" }, "id": { "type": "string", "example": "6fa3de1d94218e2ac5a51cbeaca7f846" } } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "products": { "description": "Products this product stream includes", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductStream": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product stream." }, "apiFilter": { "type": "object", "readOnly": true, "description": "Internal field." }, "invalid": { "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, "name": { "type": "string", "description": "Name of the Dynamic Group to be created." }, "description": { "type": "string", "description": "Description of the Dynamic group to be created." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "internal": { "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } }, "productCrossSellings": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "products": { "description": "Products this product stream includes", "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductStreamFilterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productStreamId", "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { "description": "Filter by field.", "type": "string" }, "operator": { "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "parent": { "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "queries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "example": "5da7eb4247add5dbd5776c9c0b38460a" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productStreamId", "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product stream filter." }, "productStreamId": { "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product's parent." }, "type": { "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { "description": "Filter by field.", "type": "string" }, "operator": { "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object", "description": "Additional parameters, such as specifying a date starting from a particular point." }, "position": { "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "parent": { "$ref": "#/components/schemas/ProductStreamFilter", "description": "Unique identity of product stream filter." }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } }, "type": "object" }, "ProductStreamMapping": { "description": "Added since version: 6.4.0.0", "required": [ "productId", "productStreamId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ProductStreamMapping." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Product's version." }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ProductStream." }, "product": { "$ref": "#/components/schemas/Product" }, "productStream": { "$ref": "#/components/schemas/ProductStream" } }, "type": "object" }, "ProductTag": { "description": "Added since version: 6.0.0.0", "required": [ "productId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product tag." }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag." }, "product": { "$ref": "#/components/schemas/Product" }, "tag": { "$ref": "#/components/schemas/Tag" }, "parentVersionId": { "description": "Unique identity of product's parent." } }, "type": "object" }, "ProductVisibilityJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "salesChannelId", "visibility" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64", "enum": [ 10, 20, 30 ] }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductVisibility": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "salesChannelId", "visibility" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of product visibility." }, "productId": { "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the product's version." }, "salesChannelId": { "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64", "enum": [ 10, 20, 30 ] }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "PromotionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { "description": "Promotion code.", "type": "string" }, "useCodes": { "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true }, "ordersPerCustomerCount": { "type": "object", "readOnly": true }, "exclusionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "setgroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/setgroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_setgroup" }, "id": { "type": "string", "example": "3c963571517f44e87274198cb8bb62a8" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "discounts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "example": "9544fa2fae515081e7fc27ef2d268642" } } } } }, "type": "object" }, "individualCodes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/individualCodes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_individual_code" }, "id": { "type": "string", "example": "c777247035736c9eae54f8e5dfdcd2aa" } } } } }, "type": "object" }, "personaRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "382af96335a79de564c412e6b493d7f3" } } } } }, "type": "object" }, "personaCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "b969a9b0d5772d70ea83383c1be06c82" } } } } }, "type": "object" }, "orderRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "ee517f71bf240d98dcf33db6e6ffa881" } } } } }, "type": "object" }, "cartRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/cartRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "6549606ef529fde0a7628b4c0aa7c6ef" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion." }, "name": { "type": "string", "description": "Name of the promotion." }, "active": { "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { "description": "Promotion code.", "type": "string" }, "useCodes": { "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true }, "ordersPerCustomerCount": { "type": "object", "readOnly": true, "description": "The number of times the customer has used the code." }, "exclusionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Unique identity of exclusion." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "setgroups": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } }, "individualCodes": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } }, "personaRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "personaCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orderRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "cartRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "orderLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } }, "type": "object" }, "PromotionCartRule": { "description": "Added since version: 6.0.0.0", "required": [ "promotionId", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion cart rule." }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionDiscountJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "promotionId", "scope", "type", "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { "description": "Cart or shipping cost.", "type": "string" }, "type": { "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { "description": "Internal field.", "type": "string" }, "usageKey": { "description": "Internal field.", "type": "string" }, "pickerKey": { "description": "Internal field.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "discountRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/discountRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "d5a1e52263eb12172f7657376d7622c8" } } } } }, "type": "object" }, "promotionDiscountPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotionDiscountPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount_prices" }, "id": { "type": "string", "example": "325723473ecab76b0f45e1554513f779" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionDiscount": { "description": "Added since version: 6.0.0.0", "required": [ "id", "promotionId", "scope", "type", "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion discount." }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { "description": "Cart or shipping cost.", "type": "string" }, "type": { "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { "description": "Internal field.", "type": "string" }, "usageKey": { "description": "Internal field.", "type": "string" }, "pickerKey": { "description": "Internal field.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "discountRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "promotionDiscountPrices": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } }, "type": "object" }, "PromotionDiscountPricesJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "discountId", "currencyId", "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountId": { "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "description": "Price of the discount.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotionDiscount": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "eaeedb5c09dfc7dbf130657ed44ef33f" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionDiscountPrices": { "description": "Added since version: 6.0.0.0", "required": [ "id", "discountId", "currencyId", "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion discount price." }, "discountId": { "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "description": "Price of the discount.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotionDiscount": { "$ref": "#/components/schemas/PromotionDiscount" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "PromotionDiscountRule": { "description": "Added since version: 6.0.0.0", "required": [ "discountId", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion discount price." }, "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of discount." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "discount": { "$ref": "#/components/schemas/PromotionDiscount" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionIndividualCodeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "promotionId", "code" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "description": "Promotion code.", "type": "string" }, "payload": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", "required": [ "id", "promotionId", "code" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion individual code." }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "description": "Promotion code.", "type": "string" }, "payload": { "type": "object", "description": "Any data related to promotion is passed." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" } }, "type": "object" }, "PromotionOrderRule": { "description": "Added since version: 6.0.0.0", "required": [ "promotionId", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion order rule." }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionPersonaCustomer": { "description": "Added since version: 6.0.0.0", "required": [ "promotionId", "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of PromotionPersonaCustomer." }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion." }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of customer." }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "customer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "PromotionPersonaRule": { "description": "Added since version: 6.0.0.0", "required": [ "promotionId", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of PromotionPersonaRule." }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "promotionId", "salesChannelId", "priority" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", "promotionId", "salesChannelId", "priority" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion on sales channel." }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "PromotionSetgroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "promotionId", "packagerKey", "sorterKey", "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { "description": "Internal field.", "type": "string" }, "sorterKey": { "description": "Internal field.", "type": "string" }, "value": { "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "setGroupRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "a54c38d5a1d9180d689d11234afbbb32" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "required": [ "id", "promotionId", "packagerKey", "sorterKey", "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion set group." }, "promotionId": { "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { "description": "Internal field.", "type": "string" }, "sorterKey": { "description": "Internal field.", "type": "string" }, "value": { "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "setGroupRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } }, "type": "object" }, "PromotionSetgroupRule": { "description": "Added since version: 6.0.0.0", "required": [ "setgroupId", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of promotion set group rule." }, "setgroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of set group." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "setgroup": { "$ref": "#/components/schemas/PromotionSetgroup" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PropertyGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayType": { "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "options": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "example": "93da65a9fd0004d9477aeac024e08e15" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PropertyGroup": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of property group." }, "name": { "type": "string", "description": "Name of the property group." }, "description": { "type": "string", "description": "Description on property group." }, "displayType": { "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { "type": "integer", "format": "int64", "description": "The order of the tabs of your defined property groups. Enter numerical values like 1,2,3, etc.to adjust their order of display." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } }, "type": "object" }, "PropertyGroupOptionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "groupId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "colorHexCode": { "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "combinable": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "group": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/group" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" }, "productConfiguratorSettings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productConfiguratorSettings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_configurator_setting" }, "id": { "type": "string", "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" } } } } }, "type": "object" }, "productProperties": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productProperties" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "bacd76b9cbbc26cb9854ec57f4d0fef3" } } } } }, "type": "object" }, "productOptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productOptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "2e96cc7eba692416e31a6af3230ebf88" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ "id", "groupId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of property group option." }, "groupId": { "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string", "description": "Name of the property group option." }, "position": { "type": "integer", "format": "int64", "description": "The order of the tabs of your defined property group options. Enter numerical values like 1,2,3, etc.to adjust their order of display." }, "colorHexCode": { "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "combinable": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "media": { "$ref": "#/components/schemas/Media" }, "group": { "$ref": "#/components/schemas/PropertyGroup" }, "productConfiguratorSettings": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, "productProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "productOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "RuleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "priority" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the rule defined.", "type": "string" }, "priority": { "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { "description": "Description of the rule.", "type": "string" }, "invalid": { "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, "areas": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "customFields": { "type": "object" }, "moduleTypes": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "conditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/conditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "b5b399ec1fcfe753f58dbafa197efdc1" } } } } }, "type": "object" }, "productPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_price" }, "id": { "type": "string", "example": "186169119da6d813def53830287d0b9a" } } } } }, "type": "object" }, "shippingMethodPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method_price" }, "id": { "type": "string", "example": "3702bcc7b41585828b44acbbdcd83b23" } } } } }, "type": "object" }, "shippingMethodPriceCalculations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method_price" }, "id": { "type": "string", "example": "b8ea8aac272229a90f9a6cb1fcada8d1" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "personaPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "e6c8f116c04f26f18410d2d0dbd677db" } } } } }, "type": "object" }, "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" }, "taxProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_provider" }, "id": { "type": "string", "example": "01a1a9d428b6402dc8255d99c787a00e" } } } } }, "type": "object" }, "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "orderPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/orderPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "82dea0f7981e729cd7f6303cc8a1c499" } } } } }, "type": "object" }, "cartPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "2ce52c5be33293c67fb55f29fa4046a7" } } } } }, "type": "object" }, "promotionDiscounts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "example": "3ddb3f7d5ec4f032dc51f294409b68f9" } } } } }, "type": "object" }, "promotionSetGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_setgroup" }, "id": { "type": "string", "example": "b71b82231d40fdedf42133c0e71384f8" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Rule": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "priority" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "name": { "description": "Name of the rule defined.", "type": "string" }, "priority": { "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { "description": "Description of the rule.", "type": "string" }, "invalid": { "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, "areas": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true, "description": "Internal field." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "moduleTypes": { "type": "object", "description": "It can be used in cart or shipping pricing." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } }, "productPrices": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } }, "shippingMethodPrices": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "shippingMethodPriceCalculations": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "personaPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "flowSequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "taxProviders": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "orderPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "cartPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "promotionDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } }, "promotionSetGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } }, "extensions": { "description": "To store additional data to a rule from extensions." } }, "type": "object" }, "RuleConditionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "type", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "description": "Different rule types.", "type": "string" }, "ruleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "object" }, "position": { "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "appScriptCondition": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_script_condition" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d84ccced9bafd192ec0c6b5a8a49bc07" } } } }, "type": "object" }, "parent": { "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "RuleCondition": { "description": "Added since version: 6.0.0.0", "required": [ "id", "type", "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule condition." }, "type": { "description": "Different rule types. ", "type": "string" }, "ruleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent." }, "value": { "type": "object", "description": "Value of the RuleCondition." }, "position": { "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "rule": { "$ref": "#/components/schemas/Rule" }, "appScriptCondition": { "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { "$ref": "#/components/schemas/RuleCondition", "description": "Unique identity of rule condition." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, "RuleTag": { "description": "Added since version: 6.5.0.0", "required": [ "ruleId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule tag." }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of rule." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag." }, "rule": { "$ref": "#/components/schemas/Rule" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "SalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "typeId", "languageId", "customerGroupId", "currencyId", "paymentMethodId", "shippingMethodId", "countryId", "navigationCategoryId", "accessKey", "name", "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "typeId": { "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "footerCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "name": { "type": "string" }, "shortName": { "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "paymentMethodIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "homeCmsPageId": { "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeCmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeSlotConfig": { "type": "object" }, "homeEnabled": { "type": "boolean" }, "homeName": { "type": "string" }, "homeMetaTitle": { "type": "string" }, "homeMetaDescription": { "type": "string" }, "homeKeywords": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "salesChannelTrackingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_order" }, "id": { "type": "string", "example": "ac53756ec89dc96c6b7c724a748b1a90" } } } } }, "type": "object" }, "salesChannelTrackingCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_customer" }, "id": { "type": "string", "example": "cb8f22914de8c702eb773a34957f4124" } } } } }, "type": "object" }, "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "currencies": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currencies" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "example": "7f24d9fc4140045241b3f97bcf36bf03" } } } } }, "type": "object" }, "languages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/languages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "example": "f3e334d42863e8250c7d03efefbfd387" } } } } }, "type": "object" }, "countries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/countries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "example": "71bee43a7a930f904d6194833b9619c9" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "type": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/type" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, "language": { "description": "Default language for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "customerGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, "currency": { "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "paymentMethod": { "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "shippingMethod": { "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "country": { "description": "Default country for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "homeCmsPage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "00bba78f79ca4792a3162942ac65c768" } } } }, "type": "object" }, "domains": { "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" } } } } }, "type": "object" }, "systemConfigs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "system_config" }, "id": { "type": "string", "example": "dbcfb7a885e393eeb296543d06485547" } } } } }, "type": "object" }, "navigationCategory": { "description": "Root category for navigation menu", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/navigationCategory" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2194fe03b676158bb7a3a03f1b98b80e" } } } }, "type": "object" }, "footerCategory": { "description": "Root category for footer navigation", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/footerCategory" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a609a222a2767cf322ee21d72a0ddb3e" } } } }, "type": "object" }, "serviceCategory": { "description": "Root category for service pages", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bc70a595d052072b5d94cffea6d8d5bb" } } } }, "type": "object" }, "productVisibilities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productVisibilities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_visibility" }, "id": { "type": "string", "example": "a3534dc8df51f93286fcf577a5f8b153" } } } } }, "type": "object" }, "hreflangDefaultDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7e80830860b9b8e5b8fc8d67262680b5" } } } }, "type": "object" }, "mailHeaderFooter": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_header_footer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a21fbb0e023f5e68d5be77b969e1eb09" } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" }, "numberRangeSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/numberRangeSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_sales_channel" }, "id": { "type": "string", "example": "62db021f1d56ae4688775365be68a04f" } } } } }, "type": "object" }, "promotionSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_sales_channel" }, "id": { "type": "string", "example": "ede6dfd9f261361e1f3ada8c5385d064" } } } } }, "type": "object" }, "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config_sales_channel" }, "id": { "type": "string", "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } } }, "type": "object" }, "productReviews": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review" }, "id": { "type": "string", "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" }, "seoUrls": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "seo_url" }, "id": { "type": "string", "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "type": "object" }, "seoUrlTemplates": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "seo_url_template" }, "id": { "type": "string", "example": "02cde325fef3e680f529875e8abd60bb" } } } } }, "type": "object" }, "mainCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "main_category" }, "id": { "type": "string", "example": "1fb731fc4139cbb575429e28846f0c39" } } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" }, "analytics": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/analytics" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_analytics" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68c4283db8074b12df1660b31c0220a9" } } } }, "type": "object" }, "customerGroupsRegistrations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroupsRegistrations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "example": "ea52a61e886aa27d777ef201c6fb7fff" } } } } }, "type": "object" }, "landingPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/landingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } } }, "type": "object" }, "boundCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/boundCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "770f1f7d01437434bcdf89eee15d4bd2" } } } } }, "type": "object" }, "wishlists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/wishlists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist" }, "id": { "type": "string", "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", "typeId", "languageId", "customerGroupId", "currencyId", "paymentMethodId", "shippingMethodId", "countryId", "navigationCategoryId", "accessKey", "name", "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "typeId": { "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of navigation category's version." }, "navigationCategoryDepth": { "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "footerCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of footer category's version." }, "serviceCategoryId": { "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of service category's version." }, "mailHeaderFooterId": { "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "name": { "type": "string", "description": "Name of the sales channel." }, "shortName": { "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object", "description": "Internal field." }, "active": { "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "List of IP addresseS used when the maintenance mode is active." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "paymentMethodIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true, "description": "Unique identity of payment method." }, "homeCmsPageId": { "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeCmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of home CMS page's version." }, "homeSlotConfig": { "type": "object", "description": "Specifies detailed information about how the CMS slots are configured for sales channel." }, "homeEnabled": { "type": "boolean", "description": "When boolean value is `true`, it indicates that sales channel is included in the menu section of the homepage navigation." }, "homeName": { "type": "string", "description": "Name of the menu section for the sales channel." }, "homeMetaTitle": { "type": "string", "description": "A page title indexed by search engines and appears in search results listings." }, "homeMetaDescription": { "type": "string", "description": "A short description of the page for search results listings." }, "homeKeywords": { "type": "string", "description": "Keywords that help to search the sales channel." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "extensions": { "properties": { "salesChannelTrackingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_order" }, "id": { "type": "string", "example": "ac53756ec89dc96c6b7c724a748b1a90" } } } } }, "type": "object" }, "salesChannelTrackingCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_tracking_customer" }, "id": { "type": "string", "example": "cb8f22914de8c702eb773a34957f4124" } } } } }, "type": "object" }, "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" } }, "type": "object" }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "type": { "$ref": "#/components/schemas/SalesChannelType" }, "language": { "$ref": "#/components/schemas/Language", "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "Default currency for the sales channel" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod", "description": "Default payment method for the sales channel" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod", "description": "Default shipping method for the sales channel" }, "country": { "$ref": "#/components/schemas/Country", "description": "Default country for the sales channel" }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "homeCmsPage": { "$ref": "#/components/schemas/CmsPage" }, "domains": { "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } }, "systemConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/SystemConfig" } }, "navigationCategory": { "$ref": "#/components/schemas/Category", "description": "Root category for navigation menu" }, "footerCategory": { "$ref": "#/components/schemas/Category", "description": "Root category for footer navigation" }, "serviceCategory": { "$ref": "#/components/schemas/Category", "description": "Root category for service pages" }, "productVisibilities": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVisibility" } }, "hreflangDefaultDomain": { "$ref": "#/components/schemas/SalesChannelDomain" }, "mailHeaderFooter": { "$ref": "#/components/schemas/MailHeaderFooter" }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } }, "numberRangeSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } }, "promotionSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } }, "documentBaseConfigSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } }, "productReviews": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "seoUrls": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } }, "seoUrlTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/SeoUrlTemplate" } }, "mainCategories": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } }, "analytics": { "$ref": "#/components/schemas/SalesChannelAnalytics" }, "customerGroupsRegistrations": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } }, "landingPages": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } }, "boundCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "wishlists": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlist" } } }, "type": "object" }, "SalesChannelAnalyticsJsonApi": { "description": "Added since version: 6.2.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingId": { "description": "Unique identity for tracking.", "type": "string" }, "active": { "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { "description": "Unique identity of anonymize.", "type": "boolean" }, "trackOffcanvasCart": { "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "enhancedConversions": { "description": "When boolean value is `true`, it enables Google Ads Enhanced Conversions by sending SHA256-hashed customer email with the purchase event.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelAnalytics": { "description": "Sales channel analytics configuration", "required": [ "id", "active", "trackOrders", "anonymizeIp", "trackOffcanvasCart", "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel analytics." }, "trackingId": { "description": "Unique identity for tracking.", "type": "string" }, "active": { "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { "description": "Unique identity of anonymize.", "type": "boolean" }, "trackOffcanvasCart": { "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "enhancedConversions": { "description": "When boolean value is `true`, it enables Google Ads Enhanced Conversions by sending SHA256-hashed customer email with the purchase event.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SalesChannelCountry": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "countryId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel country." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of country." }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "country": { "$ref": "#/components/schemas/Country" } }, "type": "object" }, "SalesChannelCurrency": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel currency." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of currency." }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "SalesChannelDomainJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "url", "salesChannelId", "languageId", "currencyId", "snippetSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "url": { "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "snippetSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "543af5fd1912efc00742534f621046d3" } } } }, "type": "object" }, "salesChannelDefaultHreflang": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8d7b798a77667d73c422fb222603234c" } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelDomain": { "description": "Added since version: 6.0.0.0", "required": [ "id", "url", "salesChannelId", "languageId", "currencyId", "snippetSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel domain." }, "url": { "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" }, "currency": { "$ref": "#/components/schemas/Currency" }, "snippetSet": { "$ref": "#/components/schemas/SnippetSet" }, "salesChannelDefaultHreflang": { "$ref": "#/components/schemas/SalesChannel" }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } }, "type": "object" }, "SalesChannelLanguage": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "languageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel language." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of language." }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "SalesChannelPaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Sales Channel Payment Method." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of payment method." }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "SalesChannelShippingMethod": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Sales Channel Shipping Method." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of shipping method." }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" } }, "type": "object" }, "SalesChannelTrackingCustomerJsonApi": { "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customerId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelTrackingCustomer": { "description": "Added since version: 6.7.9.0", "required": [ "id", "customerId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SalesChannelTrackingOrderJsonApi": { "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelTrackingOrder": { "description": "Added since version: 6.7.9.0", "required": [ "id", "orderId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { "description": "A url for the sales channel type.", "type": "string" }, "iconName": { "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "manufacturer": { "type": "string" }, "description": { "type": "string" }, "descriptionLong": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelType": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel type." }, "coverUrl": { "description": "A url for the sales channel type.", "type": "string" }, "iconName": { "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "description": "Name of the sales channel type." }, "manufacturer": { "type": "string", "description": "Manufacturer name of the sales channel." }, "description": { "type": "string", "description": "A short description for sales channel type." }, "descriptionLong": { "type": "string", "description": "A detailed description for sales channel type." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "SalutationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "salutationKey", "displayName", "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { "type": "string" }, "letterName": { "type": "string" }, "customFields": { "type": "object" }, "position": { "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "customerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } } }, "type": "object" }, "orderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_customer" }, "id": { "type": "string", "example": "1e7dbe7e3bcb48d233fd80588f54c980" } } } } }, "type": "object" }, "orderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "c3182f0dc0cc20b4982616d3e0221747" } } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Salutation": { "description": "Added since version: 6.0.0.0", "required": [ "id", "salutationKey", "displayName", "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of salutation." }, "salutationKey": { "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { "type": "string", "description": "Name given for salutation and displayed in storefront. For example: Mr" }, "letterName": { "type": "string", "description": "Name given for salutation and used in the mail templates. For example, Dear Mr" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "position": { "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "orderCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } }, "orderAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } }, "type": "object" }, "ScheduledTaskJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "scheduledTaskClass", "runInterval", "defaultRunInterval", "status" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "ScheduledTask": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "scheduledTaskClass", "runInterval", "defaultRunInterval", "status" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of scheduled task." }, "name": { "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { "description": "Time when the scheduled task was last executed. ", "type": "string", "format": "date-time" }, "nextExecutionTime": { "description": "Time when the scheduled task will execute next. ", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "ScriptJsonApi": { "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "script", "hook", "name", "active" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "script": { "description": "Internal field.", "type": "string" }, "hook": { "description": "Internal field.", "type": "string" }, "name": { "description": "Internal field.", "type": "string" }, "active": { "description": "Internal field.", "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/script/f907e651164789346ae0a1e257c462d8/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Script": { "description": "Added since version: 6.4.7.0", "required": [ "id", "script", "hook", "name", "active" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of a script." }, "script": { "description": "Internal field.", "type": "string" }, "hook": { "description": "Internal field.", "type": "string" }, "name": { "description": "Internal field.", "type": "string" }, "active": { "description": "Internal field.", "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "SeoUrlJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "languageId", "foreignKey", "routeName", "pathInfo", "seoPathInfo" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", "enum": [ "frontend.detail.page", "frontend.navigation.page", "frontend.landing.page" ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SeoUrl": { "description": "Added since version: 6.0.0.0", "required": [ "id", "languageId", "foreignKey", "routeName", "pathInfo", "seoPathInfo" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Seo Url." }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \"frontend.detail.page\"", "type": "string", "enum": [ "frontend.detail.page", "frontend.navigation.page", "frontend.landing.page" ] }, "pathInfo": { "description": "Path to product URL. For example: \"/detail/bbf36734504741c79a3bbe3795b91564\"", "type": "string" }, "seoPathInfo": { "description": "Seo path to product. For example: \"Pepper-white-ground-pearl/SW10098\"", "type": "string" }, "isCanonical": { "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SeoUrlTemplateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "entityName", "routeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "routeName": { "description": "Name of the route.", "type": "string" }, "template": { "description": "Template to generate an URL.", "type": "string" }, "isValid": { "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", "required": [ "id", "entityName", "routeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Seo Url template." }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "routeName": { "description": "Name of the route.", "type": "string" }, "template": { "description": "Template to generate an URL.", "type": "string" }, "isValid": { "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "ShippingMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "deliveryTimeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "active": { "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "availabilityRuleId": { "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": { "type": "string" }, "trackingUrl": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "deliveryTime": { "description": "Estimated delivery time information", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "delivery_time" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, "availabilityRule": { "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "prices": { "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method_price" }, "id": { "type": "string", "example": "afae32efe0f84fece3f96b377b768b33" } } } } }, "type": "object" }, "media": { "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "tags": { "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "orderDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "0ba472de56dd7ba2e7bb878434321e26" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "tax": { "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, "appShippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/appShippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "09f1214e961760dbae11d49b2bf9fa2c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ShippingMethod": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "deliveryTimeId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of shipping method." }, "name": { "type": "string", "description": "Name of the shipping method." }, "technicalName": { "type": "string" }, "active": { "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "availabilityRuleId": { "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": { "type": "string", "description": "Description of each shipping method." }, "trackingUrl": { "type": "string", "description": "This URL allows to track packages." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "deliveryTime": { "$ref": "#/components/schemas/DeliveryTime", "description": "Estimated delivery time information" }, "availabilityRule": { "$ref": "#/components/schemas/Rule", "description": "Rule defining when this shipping method is available" }, "prices": { "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { "$ref": "#/components/schemas/Media", "description": "Shipping method logo or carrier image" }, "tags": { "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "orderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "tax": { "$ref": "#/components/schemas/Tax", "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" }, "ShippingMethodPriceJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, "currencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "calculationRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/calculationRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "01b78fd34df634d784131ceefffbac99" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ShippingMethodPrice": { "description": "Added since version: 6.0.0.0", "required": [ "id", "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of shipping method price." }, "shippingMethodId": { "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, "currencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" }, "description": "Contains currency-based price." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "rule": { "$ref": "#/components/schemas/Rule" }, "calculationRule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "ShippingMethodTag": { "description": "Added since version: 6.0.0.0", "required": [ "shippingMethodId", "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Shipping method tag." }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Shipping method." }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag." }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "SnippetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "setId", "translationKey", "value", "author" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "setId": { "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { "description": "Reference to the snippet in the template.", "type": "string" }, "value": { "description": "Value of the key.", "type": "string" }, "author": { "description": "Creator of the Snippet", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "set": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Snippet": { "description": "Added since version: 6.0.0.0", "required": [ "id", "setId", "translationKey", "value", "author" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of snippet." }, "setId": { "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { "description": "Reference to the snippet in the template.", "type": "string" }, "value": { "description": "Value of the key.", "type": "string" }, "author": { "description": "Creator of the Snippet", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "set": { "$ref": "#/components/schemas/SnippetSet" } }, "type": "object" }, "SnippetSetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "baseFile", "iso" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "snippets": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet" }, "id": { "type": "string", "example": "67be68a348da3b850fb7daa10b034528" } } } } }, "type": "object" }, "salesChannelDomains": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SnippetSet": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "baseFile", "iso" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of snippet set." }, "name": { "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "snippets": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } }, "salesChannelDomains": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } }, "type": "object" }, "StateMachineJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "description": "Technical name of state machine.", "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "initialStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "states": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/states" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } } }, "type": "object" }, "transitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/transitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "34fe3c1def90f54754c23fb8df6dbeb0" } } } } }, "type": "object" }, "historyEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/historyEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "83f6d6b77ef224687b7b34cfe4296bea" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of state machine." }, "technicalName": { "description": "Technical name of state machine.", "type": "string" }, "name": { "type": "string", "description": "Unique name of state machine." }, "customFields": { "type": "object" }, "initialStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "historyEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } }, "type": "object" }, "StateMachineHistoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "referencedId", "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedId": { "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "fromStateId": { "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { "description": "Unique name of transition action.", "type": "string" }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "internalComment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/fromStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b108a2a0d303fafc83ef06f6790722e8" } } } }, "type": "object" }, "toStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/toStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "integration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "776ea3bf11df5829827f7afb43c37174" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachineHistory": { "description": "Added since version: 6.0.0.0", "required": [ "id", "referencedId", "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of state machine history." }, "referencedId": { "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "description": "Name of the entity.", "type": "string" }, "fromStateId": { "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { "description": "Unique name of transition action.", "type": "string" }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "internalComment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "toStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "user": { "$ref": "#/components/schemas/User" }, "integration": { "$ref": "#/components/schemas/Integration" }, "entityId": { "description": "Unique identity of entity." } }, "type": "object" }, "StateMachineStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "stateMachineId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineTransitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineTransitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "80afc3e35f99674237f602b393d3b2ba" } } } } }, "type": "object" }, "toStateMachineTransitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineTransitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "eb2ca150be27264985d0fcf20d53408d" } } } } }, "type": "object" }, "orderTransactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } } }, "type": "object" }, "orderDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "0ba472de56dd7ba2e7bb878434321e26" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "orderTransactionCaptures": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptures" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture" }, "id": { "type": "string", "example": "a32c8bdb9e1154cf4e138a0c8faa7159" } } } } }, "type": "object" }, "orderTransactionCaptureRefunds": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptureRefunds" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "example": "24fe1cc759f5450a1d5984a61ad20bda" } } } } }, "type": "object" }, "toStateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "01326b3b7d7c9c9182eb3940bb456c50" } } } } }, "type": "object" }, "fromStateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "6e4fe8b42b9cffa16c3e7b7e4a2a836d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", "stateMachineId", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of state machine state." }, "technicalName": { "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string", "description": "Display name of StateMachineState." }, "stateMachineId": { "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "toStateMachineTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "orderTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "orderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "orderTransactionCaptures": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } }, "orderTransactionCaptureRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "toStateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "fromStateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } }, "type": "object" }, "StateMachineTransitionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "actionName", "stateMachineId", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/fromStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b108a2a0d303fafc83ef06f6790722e8" } } } }, "type": "object" }, "toStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/toStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachineTransition": { "description": "Added since version: 6.0.0.0", "required": [ "id", "actionName", "stateMachineId", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of state machine transition." }, "actionName": { "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "toStateMachineState": { "$ref": "#/components/schemas/StateMachineState" } }, "type": "object" }, "SystemConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "configurationKey", "configurationValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { "properties": { "_value": { "type": "object" } }, "type": "object" }, "salesChannelId": { "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/system-config/a59948b9e45358eaaaa1b13d9cedc248/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SystemConfig": { "description": "Added since version: 6.0.0.0", "required": [ "id", "configurationKey", "configurationValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of system configuration." }, "configurationKey": { "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { "properties": { "_value": { "type": "object", "description": "Config value for shop configurations." } }, "type": "object" }, "salesChannelId": { "description": "Unique identity of 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 }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "TagJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" }, "landingPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/landingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } } }, "type": "object" }, "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Tag": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tag." }, "name": { "type": "string", "description": "Unique name of the tag." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } }, "landingPages": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } }, "type": "object" }, "TaxJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "taxRate", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { "description": "Name defined for a Tax.", "type": "string" }, "position": { "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Tax": { "description": "Added since version: 6.0.0.0", "required": [ "id", "taxRate", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tax." }, "taxRate": { "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { "description": "Name defined for a Tax.", "type": "string" }, "position": { "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } }, "type": "object" }, "TaxProviderJsonApi": { "description": "Added since version: 6.5.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "identifier", "priority", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "description": "Unique identity of tax provider.", "type": "string" }, "active": { "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "availabilityRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxProvider": { "description": "Added since version: 6.5.0.0", "required": [ "id", "identifier", "priority", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tax provider." }, "identifier": { "description": "Unique identity of tax provider.", "type": "string" }, "active": { "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string", "description": "Name of the tax provider." }, "priority": { "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "TaxRuleJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "taxRuleTypeId", "countryId", "taxRate", "taxId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, "data": { "properties": { "states": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "zipCode": { "type": "string" }, "fromZipCode": { "type": "string" }, "toZipCode": { "type": "string" } }, "type": "object" }, "taxId": { "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "type": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/type" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "tax": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/tax" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxRule": { "description": "Added since version: 6.1.0.0", "required": [ "id", "taxRuleTypeId", "countryId", "taxRate", "taxId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tax rule." }, "taxRuleTypeId": { "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, "data": { "properties": { "states": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "Parameter that specifies the country's states where the tax rule is applicable." }, "zipCode": { "type": "string", "description": "Parameter that specifies the country's zipcode where the tax rule is applicable." }, "fromZipCode": { "type": "string", "description": "Parameter that designates from which zip code the tax rule is applicable." }, "toZipCode": { "type": "string", "description": "Parameter that designates to which zip code the tax rule is applicable." } }, "type": "object" }, "taxId": { "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "$ref": "#/components/schemas/TaxRuleType" }, "country": { "$ref": "#/components/schemas/Country" }, "tax": { "$ref": "#/components/schemas/Tax" } }, "type": "object" }, "TaxRuleTypeJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "position", "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "typeName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule-type/ebbaa02c602593b9fea23bc0256355fc/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": [ "id", "technicalName", "position", "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of tax rule type." }, "technicalName": { "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "typeName": { "type": "string", "description": "Type name can be zip code, state, or country." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } }, "type": "object" }, "ThemeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "author", "active" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "description": { "type": "string" }, "labels": { "type": "object" }, "helpTexts": { "type": "object" }, "customFields": { "type": "object" }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentThemeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "themeJson": { "type": "object" }, "baseConfig": { "type": "object" }, "configValues": { "type": "object" }, "active": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "previewMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/previewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, "dependentThemes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/dependentThemes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "f0608e2d62b88d9b9da8d6d715b6439c" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Theme": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "author", "active" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Theme." }, "technicalName": { "type": "string", "description": "Technical name of Theme." }, "name": { "type": "string", "description": "Name of theme which is translatable." }, "author": { "type": "string", "description": "Creator of the theme." }, "description": { "type": "string", "description": "Description of the theme." }, "labels": { "type": "object", "description": "Identification label given to theme." }, "helpTexts": { "type": "object", "description": "Texts from config element." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media used for previewing the theme." }, "parentThemeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent theme." }, "themeJson": { "type": "object", "description": "Internal field." }, "baseConfig": { "type": "object", "description": "Config elements of theme like header, color, etc" }, "configValues": { "type": "object", "description": "Chosen values for the configuration." }, "active": { "type": "boolean", "description": "When boolean value is `true`, the created theme can be made usable." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "previewMedia": { "$ref": "#/components/schemas/Media" }, "dependentThemes": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } }, "type": "object" }, "ThemeChild": { "description": "Added since version: 6.4.8.0", "required": [ "parentId", "childId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ThemeChild." }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of parent." }, "childId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of child." }, "parentTheme": { "$ref": "#/components/schemas/Theme" }, "childTheme": { "$ref": "#/components/schemas/Theme" } }, "type": "object" }, "ThemeMedia": { "description": "Added since version: 6.0.0.0", "required": [ "themeId", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ThemeMedia." }, "themeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of theme." }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media." }, "theme": { "$ref": "#/components/schemas/Theme" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "ThemeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "salesChannelId", "themeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of ThemeMedia." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of sales channel." }, "themeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of theme." }, "theme": { "$ref": "#/components/schemas/Theme" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "UnitJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "shortCode", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/unit/19c562a36aeb455d09534f93b4f5236f/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Unit": { "description": "Added since version: 6.0.0.0", "required": [ "id", "shortCode", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of Unit." }, "shortCode": { "type": "string", "description": "Short name for unit, e.g., m, kg." }, "name": { "type": "string", "description": "Full name of the unit, e.g., Meter, kilogram." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "UserJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "localeId", "username", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "description": "Username of the user.", "type": "string" }, "firstName": { "description": "First name of the user.", "type": "string" }, "lastName": { "description": "Last name of the user.", "type": "string" }, "title": { "description": "Title of the user.", "type": "string" }, "email": { "description": "Email of the user.", "type": "string" }, "active": { "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "mcpAllowlist": { "type": "object" }, "lastUpdatedPasswordAt": { "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "createdNotifications": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "locale": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/locale" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, "avatarMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/avatarMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "117ab0b986d2b792c775e3beeacca7c7" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "accessKeys": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/accessKeys" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user_access_key" }, "id": { "type": "string", "example": "d11944e47e101a4aaa8d7947faa56b16" } } } } }, "type": "object" }, "configs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/configs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user_config" }, "id": { "type": "string", "example": "c23f7ab876ac167e05468ef79f046cb7" } } } } }, "type": "object" }, "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/stateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "c78c7ea361b7def0876b75bd1bd37879" } } } } }, "type": "object" }, "importExportLogEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/importExportLogEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "example": "72ec794255f368c7a704e177fa9a4967" } } } } }, "type": "object" }, "aclRoles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/aclRoles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "acl_role" }, "id": { "type": "string", "example": "e050a8081a3eb1d193c23cf0ef761183" } } } } }, "type": "object" }, "recoveryUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/recoveryUser" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bf6cdb5c30f0f0d234b96e50f2953109" } } } }, "type": "object" }, "createdOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "20509127ddf2655eb49e3db3b1d710c0" } } } } }, "type": "object" }, "updatedOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "9ce34a8be6d860e8bd92feaf79e9a4a2" } } } } }, "type": "object" }, "createdCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "c0caccfe18ce8c277f15d100818139a6" } } } } }, "type": "object" }, "updatedCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "dddac98f88e37eb31b56e7e1d455fd75" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "User": { "description": "Added since version: 6.0.0.0", "required": [ "id", "localeId", "username", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the user." }, "localeId": { "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "description": "Username of the user.", "type": "string" }, "firstName": { "description": "First name of the user.", "type": "string" }, "lastName": { "description": "Last name of the user.", "type": "string" }, "title": { "description": "Title of the user.", "type": "string" }, "email": { "description": "Email of the user.", "type": "string" }, "active": { "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "mcpAllowlist": { "type": "object" }, "lastUpdatedPasswordAt": { "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "avatarId": { "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "createdNotifications": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "locale": { "$ref": "#/components/schemas/Locale" }, "avatarMedia": { "$ref": "#/components/schemas/Media" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "accessKeys": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } }, "configs": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } }, "stateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "importExportLogEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } }, "aclRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } }, "recoveryUser": { "$ref": "#/components/schemas/UserRecovery" }, "createdOrders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "updatedOrders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "createdCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "updatedCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "type": "object" }, "UserAccessKeyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "userId", "accessKey", "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-access-key/01614dd7e96bd79868128dca72e7eff8/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserAccessKey": { "description": "Added since version: 6.0.0.0", "required": [ "id", "userId", "accessKey", "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user access key." }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "UserConfigJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "userId", "key" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { "description": "Unique key for every userconfig.", "type": "string" }, "value": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-config/4b55408b66d30e27bb1593401072cd70/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserConfig": { "description": "Added since version: 6.3.5.0", "required": [ "id", "userId", "key" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user configuration." }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { "description": "Unique key for every userconfig.", "type": "string" }, "value": { "type": "object", "description": "Value of the user configuration." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "UserRecoveryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "userId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-recovery/f451cbc27abefae127822d81c5dbb338/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserRecovery": { "description": "Added since version: 6.0.0.0", "required": [ "id", "userId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user recovery." }, "userId": { "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" }, "hash": { "description": "Password hash for user recovery." } }, "type": "object" }, "WebhookJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "eventName", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "eventName": { "type": "string" }, "url": { "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "errorCount": { "type": "integer", "format": "int64", "readOnly": true }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/webhook/150c7abfca6c489fee5cb82fbb7a9bc4/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Webhook": { "description": "Added since version: 6.3.1.0", "required": [ "id", "name", "eventName", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of webhook." }, "name": { "type": "string", "description": "Unique name of webhook." }, "eventName": { "type": "string", "description": "Technical name of the event." }, "url": { "type": "string", "description": "URL to be called when the event occurs." }, "onlyLiveVersion": { "type": "boolean" }, "errorCount": { "type": "integer", "format": "int64", "readOnly": true, "description": "Parameter that indicates a delivery failure to this url." }, "active": { "type": "boolean", "description": "When boolean value is `true`, the webhook is enabled." }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "WebhookEventLogJsonApi": { "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "webhookName", "eventName", "deliveryStatus", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "description": "Unique name of app.", "type": "string" }, "webhookName": { "description": "Unique name of webhook.", "type": "string" }, "eventName": { "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { "description": "Version of teh app.", "type": "string" }, "requestContent": { "type": "object" }, "responseContent": { "type": "object" }, "responseStatusCode": { "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "customFields": { "type": "object" }, "sequence": { "type": "integer", "format": "int64", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "WebhookEventLog": { "description": "Added since version: 6.4.1.0", "required": [ "id", "webhookName", "eventName", "deliveryStatus", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of webhook event log." }, "appName": { "description": "Unique name of app.", "type": "string" }, "webhookName": { "description": "Unique name of webhook.", "type": "string" }, "eventName": { "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { "description": "Parameter that records \"success or failed\" status of the event.", "type": "string" }, "timestamp": { "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { "description": "Version of teh app.", "type": "string" }, "requestContent": { "type": "object", "description": "Represents the content sent as part of the Request." }, "responseContent": { "type": "object", "description": "Represents the content sent as part of the Response." }, "responseStatusCode": { "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "sequence": { "type": "integer", "format": "int64", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "ConsentState": { "type": "object", "required": [ "name", "scopeName", "identifier", "status", "actor", "updatedAt", "acceptedUntil" ], "properties": { "name": { "type": "string", "description": "The name of the consent" }, "scopeName": { "type": "string", "description": "The scope of the consent that defines how the identifier is resolved" }, "identifier": { "type": "string", "description": "The resolved identifier of the consent" }, "status": { "type": "string", "enum": [ "unset", "accepted", "revoked" ], "description": "The current status of the consent (requested, accepted, revoked)" }, "actor": { "type": [ "string", "null" ], "description": "The user name of the user who made the consent decision. null if never updated" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp of when the consent status was last updated. null if never updated" }, "acceptedUntil": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp until when the consent is accepted. null if never accepted" }, "acceptedRevision": { "type": [ "string", "null" ], "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." }, "latestRevision": { "type": [ "string", "null" ], "description": "The current latest revision defined for the consent. null when the consent does not use revisions." } } }, "MeasurementUnits": { "type": "object", "description": "Configuration of the measurement system", "properties": { "system": { "type": "string", "enum": [ "metric", "imperial" ], "default": "metric", "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, "units": { "type": "object", "description": "Units used in the measurement system.", "properties": { "length": { "type": "string", "enum": [ "mm", "cm", "m", "in", "ft" ], "default": "mm", "description": "Unit of length." }, "weight": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ], "default": "kg", "description": "Unit of weight." } } } } }, "Criteria": { "type": "object", "description": "Criteria to query entities.", "properties": { "page": { "description": "Search result page", "type": "integer" }, "limit": { "description": "Number of items per result page", "type": "integer" }, "filter": { "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] }, "properties": { "type": { "description": "To filter the results and aggregations with filter types like ==, >=, etc." }, "field": { "description": "To filter the results and aggregations by field like an property identifier." }, "value": { "description": "To filter the results and aggregations by value." } } }, "sort": { "type": "array", "description": "Sorting in the search result.", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Sort the search results by field like an property identifier." }, "order": { "type": "string", "description": "Sort the search results of orders by ascending or descending." }, "naturalSorting": { "type": "boolean", "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." } }, "required": [ "field" ] } }, "post-filter": { "type": "array", "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } }, "associations": { "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } }, "grouping": { "type": "array", "description": "Perform groupings over certain fields", "items": { "type": "string", "description": "Name of a field" } }, "fields": { "type": "array", "description": "Fields which should be returned in the search result.", "items": { "type": "string", "description": "Name of a field" } }, "total-count-mode": { "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", "type": "string", "default": "none", "enum": [ "none", "exact", "next-pages" ] }, "ids": { "type": "array", "description": "List of ids to search for", "items": { "type": "string" } }, "includes": { "$ref": "#/components/schemas/Includes" }, "excludes": { "$ref": "#/components/schemas/Excludes" } } }, "Includes": { "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. To return a DAL extension, list the extension by its name (for example `myExtension`); the `extensions` wrapper is then kept automatically. Listing the keyword `extensions` returns all extensions.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Excludes": { "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. Use an extension name to remove a single extension, or the keyword `extensions` to remove all of them.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Filters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } }, "SimpleFilter": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "contains", "equalsAny", "prefix", "suffix" ] }, "field": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "field", "value" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "equalsAny", "equalsAll" ] }, "field": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "field", "value" ] } ] }, "EqualsFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "equals" ] }, "field": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "type", "field", "value" ] }, "MultiNotFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "multi", "not" ] }, "operator": { "type": "string", "enum": [ "and", "or", "nor", "nand" ] }, "queries": { "$ref": "#/components/schemas/Filters" } }, "required": [ "type", "queries" ] }, "RangeFilter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "range" ] }, "field": { "type": "string" }, "parameters": { "type": "object", "properties": { "gte": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "gt": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "lte": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "lt": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } } } }, "required": [ "type", "field", "parameters" ] }, "Sort": { "type": "object", "properties": { "field": { "type": "string" }, "order": { "type": "string", "enum": [ "ASC", "DESC" ] }, "naturalSorting": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "field", "order" ] }, "Associations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Criteria" } }, "Aggregation": { "anyOf": [ { "$ref": "#/components/schemas/AggregationMetrics" }, { "title": "AggregationEntity", "allOf": [ { "$ref": "#/components/schemas/AggregationEntity" }, { "$ref": "#/components/schemas/SubAggregations" } ] }, { "title": "AggregationFilter", "allOf": [ { "$ref": "#/components/schemas/AggregationFilter" }, { "$ref": "#/components/schemas/SubAggregations" } ] }, { "title": "AggregationTerms", "allOf": [ { "$ref": "#/components/schemas/AggregationTerms" }, { "$ref": "#/components/schemas/SubAggregations" } ] }, { "title": "AggregationHistogram", "allOf": [ { "$ref": "#/components/schemas/AggregationHistogram" }, { "$ref": "#/components/schemas/SubAggregations" } ] }, { "title": "AggregationRange", "allOf": [ { "$ref": "#/components/schemas/AggregationRange" }, { "$ref": "#/components/schemas/SubAggregations" } ] } ] }, "SubAggregations": { "type": "object", "properties": { "aggregation": { "anyOf": [ { "$ref": "#/components/schemas/AggregationMetrics" }, { "$ref": "#/components/schemas/AggregationEntity" }, { "$ref": "#/components/schemas/AggregationFilter" }, { "$ref": "#/components/schemas/AggregationTerms" }, { "$ref": "#/components/schemas/AggregationHistogram" }, { "$ref": "#/components/schemas/AggregationRange" } ] } } }, "AggregationEntity": { "title": "AggregationEntity", "type": "object", "properties": { "name": { "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { "description": "The type of aggregation", "type": "string", "enum": [ "entity" ] }, "field": { "description": "The field you want to aggregate over.", "type": "string" }, "definition": { "description": "The entity definition e.g \"product_manufacturer\".", "type": "string" } }, "required": [ "name", "type", "field", "definition" ] }, "AggregationFilter": { "title": "AggregationFilter", "type": "object", "properties": { "name": { "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { "description": "The type of aggregation", "type": "string", "enum": [ "filter" ] }, "filter": { "type": "array", "items": { "$ref": "#/components/schemas/Filters" } } }, "required": [ "name", "type", "filter" ] }, "AggregationTerms": { "title": "AggregationTerms", "type": "object", "properties": { "name": { "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { "description": "The type of aggregation", "type": "string", "enum": [ "terms" ] }, "field": { "description": "The field you want to aggregate over.", "type": "string" }, "limit": { "description": "The number of terms to return", "type": "number" }, "sort": { "type": "array", "description": "Sorting the aggregation result.", "items": { "$ref": "#/components/schemas/Sort" } } }, "required": [ "name", "type", "field" ] }, "AggregationHistogram": { "title": "AggregationHistogram", "type": "object", "properties": { "name": { "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { "description": "The type of aggregation", "type": "string", "enum": [ "histogram" ] }, "field": { "description": "The field you want to aggregate over.", "type": "string" }, "interval": { "description": "The interval of the histogram", "type": "number" }, "format": { "description": "The format of the histogram", "type": "string" }, "timeZone": { "description": "The timezone of the histogram", "type": "string" } }, "required": [ "name", "type", "field" ] }, "AggregationRange": { "title": "AggregationRange", "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", "type": "object", "properties": { "name": { "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { "description": "The type of aggregation", "type": "string", "enum": [ "range" ] }, "field": { "description": "The field you want to aggregate over.", "type": "string" }, "ranges": { "description": "The ranges of the aggregation", "type": "array", "items": { "type": "object", "anyOf": [ { "type": "object", "title": "From and to", "properties": { "from": { "type": "number", "description": "The lower bound of the range" }, "to": { "type": "number", "description": "The upper bound of the range" } }, "required": [ "from", "to" ] }, { "type": "object", "title": "From only", "properties": { "from": { "type": "string", "description": "The lower bound of the range" } }, "required": [ "from" ] }, { "type": "object", "title": "To only", "properties": { "to": { "type": "string", "description": "The upper bound of the range" } }, "required": [ "to" ] } ] } } }, "required": [ "name", "type", "field", "ranges" ] }, "AggregationMetrics": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "avg", "count", "max", "min", "stats", "sum" ] }, "field": { "type": "string" } }, "required": [ "name", "type", "field" ] }, "infoConfigResponse": { "type": "object", "properties": { "version": { "type": "string", "description": "Shopware version." }, "shopId": { "type": "string", "description": "Unique shop identifier." }, "versionRevision": { "type": "string", "description": "Shopware version revision (build hash/revision)." }, "adminWorker": { "type": "object", "description": "Admin worker feature flags and transport configuration.", "properties": { "enableAdminWorker": { "type": "boolean", "description": "Whether the admin background worker is enabled." }, "enableQueueStatsWorker": { "type": "boolean", "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", "deprecated": true }, "enableNotificationWorker": { "type": "boolean", "description": "Whether the notification worker is enabled." }, "transports": { "type": "array", "description": "Configured Symfony Messenger transports used by the admin workers.", "items": { "type": "string" } } }, "additionalProperties": false }, "bundles": { "type": "object", "description": "Active extension assets (plugins & apps) keyed by technical name.", "additionalProperties": { "oneOf": [ { "type": "object", "description": "Plugin bundle asset descriptor.", "properties": { "type": { "type": "string", "enum": [ "plugin" ] }, "css": { "type": "array", "items": { "type": "string", "description": "URL to a CSS asset." } }, "js": { "type": "array", "items": { "type": "string", "description": "URL to a JS asset." } }, "baseUrl": { "type": [ "string", "null" ], "description": "Base URL to a (micro frontend) admin entry point, if provided." } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "description": "App bundle descriptor.", "properties": { "type": { "type": "string", "enum": [ "app" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "integrationId": { "type": "string", "description": "Lowercase hex integration id." }, "baseUrl": { "type": "string" }, "version": { "type": "string" }, "permissions": { "type": "object", "description": "Grouped privileges: key = privilege scope, value = list of entities.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "css": { "type": "array", "items": { "type": "string" }, "description": "Optional CSS assets if provided." }, "js": { "type": "array", "items": { "type": "string" }, "description": "Optional JS assets if provided." } }, "required": [ "type", "name", "active", "integrationId", "baseUrl", "version", "permissions" ], "additionalProperties": false } ] } }, "settings": { "type": "object", "description": "Selected environment and feature settings consumed by the administration.", "properties": { "enableUrlFeature": { "type": "boolean", "description": "State of the URL upload feature." }, "appUrlReachable": { "type": "boolean", "description": "Whether configured APP_URL is externally reachable." }, "appsRequireAppUrl": { "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, "firstMigrationDate": { "type": [ "string", "null" ], "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", "items": { "type": "string" } }, "enableHtmlSanitizer": { "type": "boolean", "description": "Whether HTML sanitizer is enabled." }, "enableStagingMode": { "type": "boolean", "description": "Whether staging mode banner is enabled." }, "disableExtensionManagement": { "type": "boolean", "description": "True if runtime extension management is disabled." }, "presignedUploadSupported": { "type": "boolean", "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." } }, "required": [ "firstMigrationDate" ], "additionalProperties": false }, "inAppPurchases": { "type": "array", "description": "In-app purchase meta data (structure may vary).", "items": { "type": "object", "description": "Purchase entry.", "additionalProperties": true } } }, "required": [ "version", "shopId", "versionRevision", "adminWorker", "bundles", "settings", "inAppPurchases" ], "additionalProperties": false }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", "enum": [ "write", "user-verified", "admin", "write user-verified", "write admin", "user-verified admin", "write user-verified admin" ] }, "OAuthGrant": { "type": "object", "properties": { "grant_type": { "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", "type": "string" } }, "required": [ "grant_type" ], "discriminator": { "propertyName": "grant_type", "mapping": { "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", "password": "#/components/schemas/OAuthPasswordGrant", "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" } } }, "OAuthClientCredentialsGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string" }, "client_secret": { "description": "Password of the client that should be authenticated.", "type": "string" } }, "required": [ "client_id", "client_secret" ] } ] }, "OAuthPasswordGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string", "enum": [ "administration" ] }, "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "username": { "description": "Username of the user that should be authenticated.", "type": "string" }, "password": { "description": "Password of the user that should be authenticated.", "type": "string" } }, "required": [ "client_id", "scope", "username", "password" ] } ] }, "OAuthRefreshTokenGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string", "enum": [ "administration" ] }, "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "refresh_token": { "description": "The refresh token that should be used to refresh the access token.", "type": "string" } }, "required": [ "client_id", "scope", "refresh_token" ] } ] }, "Price": { "type": "object", "description": "Price object", "properties": { "currencyId": { "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "Gross price for the associated currency.", "type": "number" }, "net": { "description": "Net price for the associated currency.", "type": "number" }, "linked": { "description": "Whether gross and net prices are linked through the tax configuration.", "type": "boolean" }, "percentage": { "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", "type": [ "object", "null" ], "properties": { "gross": { "description": "Discount percentage relative to the gross list price.", "type": "number" }, "net": { "description": "Discount percentage relative to the net list price.", "type": "number" } }, "required": [ "gross", "net" ] }, "listPrice": { "description": "Reference list price for displaying discounts.", "type": "object", "properties": { "currencyId": { "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "Gross list price for the associated currency.", "type": "number" }, "net": { "description": "Net list price for the associated currency.", "type": "number" }, "linked": { "description": "Whether gross and net list prices are linked through the tax configuration.", "type": "boolean" } }, "required": [ "gross", "net", "linked" ] }, "regulationPrice": { "description": "Reference price used for legal price disclosures.", "type": "object", "properties": { "currencyId": { "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "Gross regulation price for the associated currency.", "type": "number" }, "net": { "description": "Net regulation price for the associated currency.", "type": "number" }, "linked": { "description": "Whether gross and net regulation prices are linked through the tax configuration.", "type": "boolean" } }, "required": [ "gross", "net", "linked" ] } }, "required": [ "currencyId", "gross", "net", "linked" ] }, "MediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Media entity ID" }, "ExternalThumbnail": { "type": "object", "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", "required": [ "url", "width", "height" ], "properties": { "url": { "type": "string", "description": "Absolute HTTP/HTTPS URL of the thumbnail", "example": "https://cdn.example.com/image-200x200.jpg" }, "width": { "type": "integer", "exclusiveMinimum": 0, "description": "Width of the thumbnail in pixels", "example": 200 }, "height": { "type": "integer", "exclusiveMinimum": 0, "description": "Height of the thumbnail in pixels", "example": 200 } } }, "flowBuilderActionsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the flow action" }, "requirements": { "type": "array", "description": "When requirement fit with aware from `events.json` actions will be shown", "items": { "type": "string" } }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "Extensions data of event" } } } }, "businessEventsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name of the businessEventsResponse." }, "class": { "type": "string", "description": "Class name of business event." }, "data": { "type": "object", "description": "Internal field." }, "aware": { "type": "array", "description": "Parameter that indicates the areas in which the business event is supported.", "items": { "type": "string" } }, "extensions": { "type": "array", "description": "Internal field.", "items": { "type": "string" } } } } }, "Cart": { "properties": { "id": { "description": "Unique identity of cart." }, "errors": { "properties": { "key": { "description": "Unique key for every message." }, "level": { "description": "Types of level - Notice, warning and error. " }, "message": { "description": "A persistent error passed from the shopping cart calculation processes to the user end." } } }, "transactions": { "items": { "properties": { "paymentMethodId": { "description": "Unique identity of payment method." } } } }, "modified": { "description": "It signifies any changes to cart." } } }, "SalesChannelContext": { "properties": { "currentCustomerGroup": { "properties": { "name": { "description": "Name of customer group to which the customer belongs within the specific sales channel they are currently interacting with." }, "displayGross": { "description": "When `true`, product's gross price is displayed for that customer group who belongs to the specific sales channel they are currently interacting with." } } }, "currency": { "properties": { "isoCode": { "description": "Standard international three digit code to represent currency in a given sales channel. For example, USD." }, "factor": { "description": "Currency exchange rate in a specific sales channel the customer is currently interacting with." }, "symbol": { "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $ in a given sales channel." }, "shortName": { "description": "Acronym for international currencies, for example, USD in a given sales channel." }, "name": { "description": "Full name of the currency in a given sales channel. For example, US-Dollar." }, "position": { "description": "The order of the tabs for multiple currencies defined in a given sales channel." }, "decimalPrecision": { "description": "It defines the round off value for currency to the nearest decimal point in a given sales channel. If set to 2, it rounds off to two significant decimal points." }, "isSystemDefault": { "description": "Runtime field, cannot be used as part of the criteria." } } }, "salesChannel": { "properties": { "typeId": { "description": "Unique identity of a sales channel's type within a specific sales channel." }, "languageId": { "description": "Unique identity of a sales channel's language within a specific sales channel." }, "currencyId": { "description": "Unique identity of a sales channel's currency within a specific sales channel." }, "paymentMethodId": { "description": "Unique identity of a sales channel's payment method within a specific sales channel." }, "shippingMethodId": { "description": "Unique identity of a sales channel's shipping method within a specific sales channel." }, "countryId": { "description": "Unique identity of a sales channel's country within a specific sales channel." }, "navigationCategoryId": { "description": "Unique identity of a sales channel's navigation category within a specific sales channel." }, "navigationCategoryDepth": { "description": "It determines the number of levels of subcategories in the storefront category menu within a specific sales channel." }, "footerCategoryId": { "description": "Unique identity of a sales channel's footer category within a specific sales channel." }, "serviceCategoryId": { "description": "Unique identity of a sales channel's service category within a specific sales channel." }, "name": { "description": "Name of the sales channel." }, "shortName": { "description": "A short name for sales channel." }, "accessKey": { "description": "Access key to store api." }, "active": { "description": "When `true`, the sales channel is enabled." }, "maintenance": { "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." }, "maintenanceIpWhitelist": { "description": "List of IP addresseS used when the maintenance mode is active." }, "mailHeaderFooterId": { "description": "Unique identity of a sales channel's mail header and footer within a specific sales channel." }, "customerGroupId": { "description": "Unique identity of a sales channel's customer group within a specific sales channel." }, "hreflangActive": { "description": "When `true`, the sales channel pages are available in different languages within a specific sales channel." }, "hreflangDefaultDomainId": { "description": "Unique identity of a sales channel's hreflangDefaultDomain within a specific sales channel." }, "analyticsId": { "description": "Unique identity of a sales channel's analytics within a specific sales channel." } } }, "taxRules": { "properties": { "taxRate": { "description": "Rate of tax within a specific sales channel." }, "name": { "description": "Name defined for a Tax within a specific sales channel." } } }, "customer": { "properties": { "groupId": { "description": "Unique identity of a customer's group within a specific sales channel." }, "defaultPaymentMethodId": { "description": "Unique identity of a customer's default payment method within a specific sales channel." }, "salesChannelId": { "description": "Unique identity of sales channel the customer is currently interacting with." }, "languageId": { "description": "Unique identity of language within a specific sales channel the customer is interacting." }, "lastPaymentMethodId": { "description": "Unique identity of customer's last payment method within a specific sales channel." }, "defaultBillingAddressId": { "description": "Unique identity of customer's default billing address within a specific sales channel." }, "defaultShippingAddressId": { "description": "Unique identity of customer's default shipping address within a specific sales channel." }, "customerNumber": { "description": "Name of the customer within a specific sales channel the customer is interacting." }, "salutationId": { "description": "Unique identity of customer's default shipping address within a specific sales channel." }, "firstName": { "description": "First name of the customer within a specific sales channel." }, "lastName": { "description": "Last name of the customer within a specific sales channel." }, "company": { "description": "Company name of the customer within a specific sales channel." }, "password": { "description": "Password of the customer within a specific sales channel." }, "email": { "description": "Email of the customer within a specific sales channel." }, "title": { "description": "Customer's title or honorifics like Mr, Mrs, etc within a specific sales channel." }, "affiliateCode": { "description": "An affiliate code is an identification option with which website operators can mark outgoing links within a specific sales channel." }, "campaignCode": { "description": "A unique identifier for a campaign within a specific sales channel." }, "active": { "description": "When `true`, the status of the customer is set active within a specific sales channel." }, "doubleOptInRegistration": { "description": "When `true`, user subscriptions to an email marketing list is allowed within a specific sales channel." }, "doubleOptInEmailSentDate": { "description": "Date and time when the double opt-in email was sent within a specific sales channel." }, "doubleOptInConfirmDate": { "description": "Date and time when the double opt-in email was confirmed within a specific sales channel." }, "hash": { "description": "Password hash for account recovery within a specific sales channel." }, "guest": { "description": "Boolean value is `true` for a guest account within a specific sales channel." }, "firstLogin": { "description": "Captures date and time of customer's first login within a specific sales channel." }, "lastLogin": { "description": "Captures date and time of customer's last login within a specific sales channel." }, "newsletter": { "description": "When `true`, then the customer gets subscribe to the newsletter" }, "birthday": { "description": "Captures customer's birthday details within a specific sales channel." }, "lastOrderDate": { "description": "Captures customer's last order date within a specific sales channel." }, "orderCount": { "description": "Captures the number of orders placed by a customer within a specific sales channel." }, "legacyEncoder": { "description": "encapsulates shop credentials when needed to migrate shop system from old instance to new instance" }, "legacyPassword": { "description": "Hashed password of the old shop system" }, "autoIncrement": { "description": "Internal field. " }, "remoteAddress": { "description": "Anonymous IP address of the customer for last session." } } }, "paymentMethod": { "properties": { "pluginId": { "description": "Unique identity of payment plugin within a specific sales channel." }, "handlerIdentifier": { "description": "Internal field that contains system identifier details for payment methods like Paypal." }, "name": { "description": "Name of the payment method within a specific sales channel." }, "description": { "description": "A short description about the payment method within a specific sales channel." }, "position": { "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc within a specific sales channel." }, "active": { "description": "When `true`, the payment method is available for usage within a specific sales channel." }, "availabilityRuleId": { "description": "Unique identity of the rule for the payment method." }, "mediaId": { "description": "Unique identity of media used in payment method within a specific sales channel." }, "formattedHandlerIdentifier": { "description": "Internal field that contains system identifier details for payment methods like Paypal." } } }, "shippingMethod": { "properties": { "name": { "description": "Name of the shipping method within a specific sales channel." }, "active": { "description": "When `true`, the shipping method is available for usage within a specific sales channel." }, "description": { "description": "A short description about the shipping method within a specific sales channel." }, "trackingUrl": { "description": "URL that allows to track packages for a specific sales channel." }, "deliveryTimeId": { "description": "Unique identity of deliveryTime within a specific sales channel." }, "availabilityRuleId": { "description": "Unique identity of the rule for the payment method." }, "mediaId": { "description": "Unique identity of media used in shipping method within a specific sales channel." } } }, "context": { "properties": { "versionId": { "description": "Unique identity of context's version in a specific sales channel." }, "currencyId": { "description": "Unique identity of currency context in a specific sales channel." }, "currencyFactor": { "description": "Unique identity of currency factor context in a specific sales channel." }, "currencyPrecision": { "description": "It defines the round off value of currency to the nearest decimal point. If set to 2, it rounds off to two significant decimal points." }, "scope": { "description": "Scope defines if its related to system or user context." }, "source": { "description": "When context is related to user in the source, then there is userId." }, "taxState": { "description": "Tax state can either be `gross` or `net`." }, "useCache": { "description": "When boolean value is `true`, caching is used." } } } } }, "AccountNewsletterRecipientResult": { "properties": { "status": { "description": "Status indicates if the customer has subscribed to the news letter or not." } } }, "ProductDetailResponse": { "properties": { "id": { "description": "Unique identity of product detail response." }, "available": { "description": "When boolean value is true, the product is available for purchase." }, "isCloseout": { "description": "Boolean value to check if the product is still buyable when stock value is 0." }, "displayGroup": { "description": "Internal field." }, "manufacturerNumber": { "description": "Unique number of the product manufacturer." }, "stock": { "description": "Quantity of product available." }, "sortedProperties": { "description": "Properties of the product that are sorted" } } }, "ProductListingCriteria": { "properties": { "filter": { "properties": { "type": { "description": "To filter the results and aggregations with filter types like ==, >=, etc." }, "field": { "description": "To filter the results and aggregations by field like an property identifier." }, "value": { "description": "To filter the results and aggregations by value." } } }, "sort": { "properties": { "field": { "description": "Sort the search results by field like an property identifier." }, "order": { "description": "Sort the search results of orders by ascending or descending." }, "naturalSorting": { "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." } } }, "post-filter": { "properties": { "type": { "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." }, "field": { "description": "To filter only the results but not the aggregations by field like an property identifier." }, "value": { "description": "To filter only the results but not the aggregations by value." } } } } }, "CartItems": { "properties": { "items": { "properties": { "id": { "description": "Unique identity of cart item." }, "modified": { "description": "When boolean value is `true`, the cart is said to be modified." } } } } }, "FindProductVariantRouteResponse": { "properties": { "foundCombination": { "properties": { "variantId": { "description": "Unique identity of a variant." }, "options": { "description": "Available product variant options. For example, for variant `Size`, option would be `XS`, `S`, `M`, `L`, `XL`." } } } } }, "OrderProductWarehouse": { "properties": { "id": { "description": "Unique identity of order's product warehouse." }, "versionId": { "description": "Unique identity of order product warehouse's version." }, "orderId": { "description": "Unique identity of order." }, "orderVersionId": { "description": "Unique identity of order's version." }, "productId": { "description": "Unique identity of product." }, "productVersionId": { "description": "Unique identity of product's version." }, "warehouseId": { "description": "Unique identity of warehouse." }, "quantity": { "description": "Number of items of each product." } } }, "OrderReturn": { "properties": { "id": { "description": "Unique identity of order return." }, "versionId": { "description": "Unique identity of order return's version." }, "orderId": { "description": "Unique identity of order." }, "orderVersionId": { "description": "Unique identity of order return version." }, "price": { "properties": { "netPrice": { "description": "Net price of the product." }, "totalPrice": { "description": "Gross price of the product." }, "calculatedTaxes": { "description": "Contains calculated tax on order delivery price." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "positionPrice": { "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc." }, "rawTotal": { "description": "The total value before rounding off." }, "taxStatus": { "description": "TaxStatus takes `Free`, `Net` or `Gross` as values." } } }, "shippingCosts": { "properties": { "unitPrice": { "description": "Shipping cost of product per item (where, quantity=1)." }, "totalPrice": { "description": "Shipping cost of product based on quantity." }, "quantity": { "description": "Number of items of each product." }, "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "price": { "description": "Price of each line item." }, "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } }, "stateId": { "description": "Unique identity of state." }, "returnNumber": { "description": "Reference number for returning order." }, "requestedAt": { "description": "Date and time when the order return was requested." }, "amountTotal": { "description": "Gross price of the order." }, "amountNet": { "description": "Net price of the order." }, "internalComment": { "description": "Comments that are visible to only shop owner." }, "createdById": { "description": "Unique identity of createdBy." }, "updatedById": { "description": "Unique identity of updatedBy." } } }, "OrderReturnLineItem": { "properties": { "id": { "description": "Unique identity of order return line item." }, "versionId": { "description": "Unique identity of order return line item's version." }, "orderReturnId": { "description": "Unique identity of order return." }, "orderReturnVersionId": { "description": "Unique identity of order return version." }, "orderLineItemId": { "description": "Unique identity of order line item." }, "orderLineItemVersionId": { "description": "Unique identity of order line items's version." }, "reasonId": { "description": "Unique identity of reason for return." }, "quantity": { "description": "Number of line items returned." }, "shippingCosts": { "properties": { "unitPrice": { "description": "Shipping cost of product per item (where, quantity=1)." }, "totalPrice": { "description": "Shipping cost of product based on quantity." }, "quantity": { "description": "Number of items of each product." }, "calculatedTaxes": { "description": "Contains calculated taxes based on shipping costs/methods." }, "taxRules": { "description": "Pricing based on multiple taxes." }, "referencePrice": { "description": "Original cost price of the product." }, "listPrice": { "properties": { "discount": { "description": "Absolute discount on each line item." }, "percentage": { "description": "Discount in percentage." } } }, "regulationPrice": { "properties": { "price": { "description": "Contains cheapest price from last 30 days as per EU law." } } } } }, "refundAmount": { "description": "Amount to be refunded." }, "restockQuantity": { "description": "Update of stock quantity after the return of certain line items are initiated." }, "internalComment": { "description": "Comments that are visible to only shop owner." }, "customFields": { "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "stateId": { "description": "Unique identity of state." } } }, "OrderReturnLineItemReturn": { "properties": { "shippingCosts": { "properties": { "listPrice": { "properties": { "price": { "description": "Price of each line item." } } } } } } }, "OrderReturnLineItemReason": { "properties": { "reason": { "properties": { "id": { "description": "Unique identity for reason of return." }, "reasonKey": { "description": "Unique key associated with reason for the order return. " }, "content": { "description": "Description of the reason of return." }, "translated": { "description": "Contains the translations of all translated fields." } } } } }, "OrderWarehouseGroup": { "properties": { "id": { "description": "Unique identity of order warehouse group." }, "versionId": { "description": "Unique identity of order warehouse group's version." }, "orderId": { "description": "Unique identity of order." }, "orderVersionId": { "description": "Unique identity of order's version'." }, "warehouseGroupId": { "description": "Unique identity of warehouse group." } } }, "ProductReviewSummary": { "properties": { "id": { "description": "Unique identity of products's review summary." }, "productId": { "description": "Unique identity of products." }, "productVersionId": { "description": "Unique identity of product's version." }, "salesChannelId": { "description": "Unique identity of sales channel." }, "summary": { "description": "Unique identity of products's review summary." }, "visible": { "description": "When boolean value is `true`, the review is displayed to the customer." }, "translated": { "description": "Contains the translations of all translated fields." } } }, "ProductWarehouse": { "properties": { "id": { "description": "Unique identity of product warehouse." }, "productId": { "description": "Unique identity of product." }, "productVersionId": { "description": "Unique identity of product's version." }, "warehouseId": { "description": "Unique identity of warehouse." }, "stock": { "description": "Quantity of product available." } } }, "ProductWarehouseGroup": { "properties": { "id": { "description": "Unique identity of warehouse of product." }, "productId": { "description": "Unique identity of product." }, "productVersionId": { "description": "Unique identity of product's version." }, "warehouseGroupId": { "description": "Unique identity of warehouse group." } } }, "Subscription": { "properties": { "id": { "description": "Unique identity of subscription." }, "convertedOrder": { "description": "An array loaded with persistent information related to cart data." }, "subscriptionNumber": { "description": "Unique number associated with subscription." }, "nextSchedule": { "description": "Date and time of next scheduled subscription for example: `yyyy-mm-dd hh:mm:ss` - `2023-08-15 15:25:32`." }, "salesChannelId": { "description": "Unique identity of sales channel." }, "subscriptionPlanId": { "description": "Unique identity of subscription plan." }, "subscriptionPlanName": { "description": "Unique name for subscription plan." }, "subscriptionIntervalId": { "description": "Unique identity for subscription interval." }, "subscriptionIntervalName": { "description": "Unique name for subscription interval." }, "dateInterval": { "description": "Relative interval data. For example, `every 3 days`, `every 2 months`, etc." }, "cronInterval": { "description": "Absolute interval data. For example, `only on January`, `only on Mondays`, etc." }, "initialExecutionCount": { "description": "The initialExecutionCount is the number of contract terms the merchants subscribes for; for example : 12 for 12 months." }, "remainingExecutionCount": { "description": "The remainingExecutionCount is the count of executions, the subscriptions has to run through before the customer can cancel it. For example : 3 for 3 months remaining." }, "billingAddressId": { "description": "Unique identity of billing address." }, "shippingAddressId": { "description": "Unique identity of shipping address." }, "shippingMethodId": { "description": "Unique identity of shipping method." }, "paymentMethodId": { "description": "Unique identity of payment method." }, "currencyId": { "description": "Unique identity of currency." }, "languageId": { "description": "Unique identity of language." }, "stateId": { "description": "Unique identity of state." }, "customFields": { "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "itemRounding": { "properties": { "decimals": { "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "description": "The cash rounding applied on net prices." } } }, "totalRounding": { "properties": { "decimals": { "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, "interval": { "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." }, "roundForNet": { "description": "The cash rounding applied on net prices. " } } } } }, "SubscriptionAddress": { "properties": { "id": { "description": "Unique identity of subscription address." }, "countryId": { "description": "Unique identity of country." }, "subscriptionId": { "description": "Unique identity of subscription." }, "countryStateId": { "description": "Unique identity of state of the country." }, "salutationId": { "description": "Unique identity of salutation." }, "firstName": { "description": "First name of the subscribed customer." }, "lastName": { "description": "Last name of the subscribed customer." }, "street": { "description": "Street address" }, "zipcode": { "description": "Zip code of the country." }, "city": { "description": "Name of the city." }, "company": { "description": "Name of the company." }, "department": { "description": "Name of the department." }, "title": { "description": "Title name given to customer's order address." }, "vatId": { "description": "Unique identity of VAT." }, "phoneNumber": { "description": "Phone number of the customer." }, "additionalAddressLine1": { "description": "Additional address input if necessary." }, "additionalAddressLine2": { "description": "Additional address input if necessary." }, "customFields": { "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "email": { "description": "Last name of the subscribed customer. " } } }, "SubscriptionCustomer": { "properties": { "id": { "description": "Unique identity of subscription customer." }, "subscriptionId": { "description": "Unique identity of subscription." }, "customerId": { "description": "Unique identity of the customer." }, "salutationId": { "description": "Unique identity of salutation." }, "firstName": { "description": "Email address of the subscribed customer." }, "lastName": { "description": "Last name of the subscribed customer. " }, "company": { "description": "Name of the customer's company." }, "title": { "description": "Title name given to customer's order address." }, "customerNumber": { "description": "Unique number for subscribed customer." }, "vatId": { "description": "Unique identity of VAT." }, "customFields": { "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "remoteAddress": { "description": "Anonymous IP address of the customer for last session." } } }, "SubscriptionInterval": { "properties": { "id": { "description": "Unique identity of subscription interval." }, "name": { "description": "Name of the subscription interval." }, "active": { "description": "When `true`, the defined subscription interval is available for selection in storefront." }, "dateInterval": { "description": "Relative interval data. For example, `every 3 days`, `every 2 months`, etc." }, "cronInterval": { "description": "Absolute interval data. For example, `only on January`, `only on Mondays`, etc." }, "availabilityRuleId": { "description": "Unique identity of rule." }, "translated": { "description": "Contains the translations of all translated fields." } } }, "SubscriptionPlan": { "properties": { "id": { "description": "Unique identity of subscription plan." }, "name": { "description": "Name of the subscription plan." }, "description": { "description": "A short description about the subscription plan." }, "active": { "description": "When `true`, the subscription plan is available for selection in storefront." }, "minimumExecutionCount": { "description": "The minimumExecutionCount is the minimum count of executions i.e, the minimum subscription limit set for the subscribers. For example, 2 months." }, "activeStorefrontLabel": { "description": "When boolean value id `true`, the label overrides the plan name." }, "availabilityRuleId": { "description": "Unique identity of rule." }, "label": { "description": "Label that can overwrite the active plan name. " }, "translated": { "description": "Contains the translations of all translated fields." } } }, "SubscriptionPlanIntervalMapping": { "properties": { "id": { "description": "Unique identity of subscription plan interval mapping." }, "subscriptionIntervalId": { "description": "Unique identity of subscription interval." }, "subscriptionPlanId": { "description": "Unique identity of subscription plan." } } }, "SubscriptionPlanProductMapping": { "properties": { "id": { "description": "Unique identity of subscription plan for product mapping." }, "productId": { "description": "Unique identity of product." }, "productVersionId": { "description": "Unique identity of product's version." }, "subscriptionPlanId": { "description": "Unique identity of subscription plan." } } }, "SubscriptionTagMapping": { "properties": { "id": { "description": "Unique identity of subscription tag." }, "subscriptionId": { "description": "Unique identity of subscription." }, "tagId": { "description": "Unique identity of subscription tag." } } }, "SwagDelayAction": { "properties": { "id": { "description": "Unique identity of swag delay action for flow builder." }, "eventName": { "description": "Unique name of the event." }, "flowId": { "description": "Unique identity of flow." }, "orderId": { "description": "Unique identity of order." }, "orderVersionId": { "description": "Unique identity of order's version." }, "customerId": { "description": "Unique identity of customer." }, "executionTime": { "description": "Parameters that determine when the flow action is to be executed." }, "expired": { "description": "Parameter that determines when the flow action ceases to run." }, "delaySequenceId": { "description": "Unique identity of delaySequence." }, "stored": { "description": "Internal field." } } }, "SwagSequenceWebhookEventLog": { "properties": { "id": { "description": "Unique identity of Swag Sequence Webhook Event Log." }, "sequenceId": { "description": "Unique identity of sequence." }, "webhookEventLogId": { "description": "Unique identity of Webhook Event Log." } } }, "Warehouse": { "properties": { "id": { "description": "Unique identity of warehouse." }, "name": { "description": "Unique name of warehouse." }, "description": { "description": "A short description of warehouse." } } }, "WarehouseGroup": { "properties": { "id": { "description": "Unique identity of warehouse group." }, "name": { "description": "Unique name of warehouse group." }, "description": { "description": "A short description of warehouse group." }, "priority": { "description": "A numerical value to prioritize one of the warehouse groups from the list." }, "ruleId": { "description": "Unique identity of rule." } } }, "WarehouseGroupWarehouse": { "properties": { "id": { "description": "Unique identity of WarehouseGroupWarehouse." }, "warehouseId": { "description": "Unique identity of Warehouse." }, "warehouseGroupId": { "description": "Unique identity of WarehouseGroup." }, "priority": { "description": "A numerical value to prioritize one the WarehouseGroupWarehouse from the list." } } }, "flowBulderActionsResponse": { "properties": { "name": { "description": "Unique name of the flowBulderActionsResponse." }, "extensions": { "description": "Internal field." } } }, "LineItem": { "properties": { "id": { "description": "Unique identity of line item." }, "referencedId": { "description": "Unique identity of type of entity." }, "label": { "description": "It is a typical product name given to the line item." }, "quantity": { "description": "Number of items of product." }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance." }, "good": { "description": "When set to true, it indicates the line item is physical else it is virtual." }, "description": { "description": "Description of line items in an order." }, "removable": { "description": "Allows the line item to be removable from the cart when set to true." }, "stackable": { "description": "Allows to change the quantity of the line item when set to true." }, "modified": { "description": "When boolean value is `true`, line items are said to be modified." } } }, "CrossSellingElementCollection": { "properties": { "total": { "description": "Number of cross selling elements found." } } }, "NavigationRouteResponse": { "properties": { "id": { "description": "Unique identity of navigation route response." } } }, "WishlistLoadRouteResponse": { "properties": { "wishlist": { "properties": { "customerId": { "description": "Unique identity of the customer." }, "salesChannelId": { "description": "Unique identity of the sales channel." } } } } }, "Sitemap": { "properties": { "filename": { "description": "Name of the file which holds a list of all URL's." } } }, "AdvancedSearchConfig": { "properties": { "id": { "description": "Unique identity of advanced search config." }, "salesChannelId": { "description": "Unique identity of sales channel." }, "esEnabled": { "description": "When boolean value is `true`, advanced search is enabled." }, "andLogic": { "description": "Advanced search configuration with add logic." }, "minSearchLength": { "description": "Minimum number of characters used for advanced search." }, "hitCount": { "description": "Parameter that indicates the number of times the product is searched.", "properties": { "product": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested product hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the product search." } } }, "product_manufacturer": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the product_manufacturer search." } } }, "category": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the category search." } } } } }, "fields": { "properties": { "id": { "description": "Unique identity of fields." }, "configId": { "description": "Unique identity of config." }, "customFieldId": { "description": "Unique identity of custom field." }, "entity": { "description": "Indicates in which particular entity." }, "field": { "description": "Information of the configured advanced search field." }, "tokenize": { "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks." }, "searchable": { "description": "When a field is searchable, it means that it can be used as a search criterion when conducting advanced searches. " }, "ranking": { "description": "Search ranking." } } } } }, "AdvancedSearchConfigField": { "properties": { "id": { "description": "Unique identity of advanced search config field." }, "configId": { "description": "Unique identity of configuration." }, "customFieldId": { "description": "Unique identity of custom field." }, "entity": { "description": "Indicates in which particular entity." }, "field": { "description": "Information of the configured advanced search field." }, "tokenize": { "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks." }, "searchable": { "description": "When a field is searchable, it means that it can be used as a search criterion when conducting advanced searches. " }, "ranking": { "description": "Search ranking." }, "config": { "properties": { "id": { "description": "Unique identity of advanced search field." }, "salesChannelId": { "description": "Unique identity of sales channel." }, "esEnabled": { "description": "When boolean value is `true`, advanced search is enabled." }, "andLogic": { "description": "Advanced search field configuration with add logic." }, "minSearchLength": { "description": "Minimum number of characters used for advanced search field." }, "hitCount": { "description": "Parameter that indicates the number of times the product is searched.", "properties": { "product": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the product search." } } }, "product_manufacturer": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the product_manufacturer search." } } }, "category": { "properties": { "maxSuggestCount": { "description": "Maximum number of suggested hits or recommendations that will be provided in response to a search." }, "maxSearchCount": { "description": "The maximum count value that you can specify for the category search." } } } } }, "fields": { "properties": { "id": { "description": "Unique identity of fields." }, "configId": { "description": "Unique identity of config." }, "customFieldId": { "description": "Unique identity of custom field." }, "entity": { "description": "Indicates in which particular entity." }, "field": { "description": "Information of the configured advanced search field." }, "tokenize": { "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks." }, "searchable": { "description": "When a field is searchable, it means that it can be used as a search criterion when conducting advanced searches. " }, "ranking": { "description": "Search ranking." } } } } } } }, "CustomPrice": { "properties": { "id": { "description": "Unique identity of the custom price." }, "productId": { "description": "Unique identity of the product." }, "productVersionId": { "description": "Unique identity of the product's version." }, "customerId": { "description": "Unique identity of the customer." }, "customerGroupId": { "description": "Unique identity of the customer's group." }, "price": { "description": "Detailed information of price." } } }, "CustomerSpecificFeatures": { "properties": { "id": { "description": "Unique identity of the customer specific features." }, "customerId": { "description": "Unique identity of the customer." }, "features": { "description": "The actual product features." } } }, "MediaAiTag": { "properties": { "id": { "description": "Unique identity of the AI media tag." }, "mediaId": { "description": "Unique identity of the media." }, "needsAnalysis": { "description": "When boolean value is `true`, indicates whether the associated media content requires further analysis by AI." }, "tag": { "description": "Tag that indicates if the media is made by AI or not." }, "translated": { "description": "Contains the translations of all translated fields." } } } }, "responses": { "404": { "description": "Not Found", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "404", "title": "Not Found", "description": "Resource with given parameter was not found." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "404", "title": "Not Found", "description": "Resource with given parameter was not found." } ] } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "403", "title": "Forbidden", "description": "This operation is restricted to logged in users." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "403", "title": "Forbidden", "description": "This operation is restricted to logged in users." } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "401", "title": "Unauthorized", "description": "Authorization information is missing or invalid." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "401", "title": "Unauthorized", "description": "Authorization information is missing or invalid." } ] } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "400", "title": "Bad Request", "description": "Bad parameters for this endpoint. See documentation for the correct ones." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/failure" }, "example": { "errors": [ { "status": "400", "title": "Bad Request", "description": "Bad parameters for this endpoint. See documentation for the correct ones." } ] } } } }, "204": { "description": "No Content" }, "OpenApi3": { "description": "Returns information about the admin API.", "content": { "application/json": { "schema": { "properties": { "openapi": { "type": "string" }, "info": { "type": "object", "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "termsOfService": { "type": "string", "format": "uri" }, "contact": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "email": { "type": "string", "format": "email" } } }, "license": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "name" ] }, "version": { "type": "string" } }, "required": [ "title", "version" ] }, "jsonSchemaDialect": { "type": "string" }, "webhooks": { "type": "object" }, "servers": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "components": { "type": "object", "properties": { "schemas": { "type": "object" }, "responses": { "type": "object" }, "parameters": { "type": "object" }, "examples": { "type": "object" }, "requestBodies": { "type": "object" }, "headers": { "type": "object" }, "securitySchemes": { "type": "object" }, "links": { "type": "object" }, "callbacks": { "type": "object" }, "pathItems": { "type": "object" } } }, "security": { "type": "array", "items": { "type": "object" } }, "paths": { "type": "object" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "externalDocs": { "type": "object", "properties": { "description": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] } }, "required": [ "name" ] } }, "externalDocs": { "type": "object", "properties": { "description": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] } }, "type": "object", "required": [ "openapi", "info" ] } } } } }, "securitySchemes": { "oAuth": { "type": "oauth2", "description": "Authentication using OAuth 2.0", "flows": { "password": { "tokenUrl": "/api/oauth/token", "scopes": { "write": "Full write access", "admin": "Admin scope for administrative operations" } }, "clientCredentials": { "tokenUrl": "http://localhost:8000/api/oauth/token", "scopes": { "write": "Full write access" } } } } } }, "security": [ { "oAuth": [ "write" ] } ], "tags": [ { "name": "Experimental", "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { "name": "App", "description": "The endpoint for operations on App" }, { "name": "App Action Button", "description": "The endpoint for operations on App Action Button" }, { "name": "App Administration Snippet", "description": "The endpoint for operations on App Administration Snippet" }, { "name": "App Cms Block", "description": "The endpoint for operations on App Cms Block" }, { "name": "App Flow Action", "description": "The endpoint for operations on App Flow Action" }, { "name": "App Flow Event", "description": "The endpoint for operations on App Flow Event" }, { "name": "App Mcp Prompt", "description": "The endpoint for operations on App Mcp Prompt" }, { "name": "App Mcp Resource", "description": "The endpoint for operations on App Mcp Resource" }, { "name": "App Mcp Tool", "description": "The endpoint for operations on App Mcp Tool" }, { "name": "App Payment Method", "description": "The endpoint for operations on App Payment Method" }, { "name": "App Script Condition", "description": "The endpoint for operations on App Script Condition" }, { "name": "App Shipping Method", "description": "The endpoint for operations on App Shipping Method" }, { "name": "App Template", "description": "The endpoint for operations on App Template" }, { "name": "Category", "description": "The endpoint for operations on Category" }, { "name": "Cms Block", "description": "The endpoint for operations on Cms Block" }, { "name": "Cms Page", "description": "The endpoint for operations on Cms Page" }, { "name": "Cms Section", "description": "The endpoint for operations on Cms Section" }, { "name": "Cms Slot", "description": "The endpoint for operations on Cms Slot" }, { "name": "Country", "description": "The endpoint for operations on Country" }, { "name": "Country State", "description": "The endpoint for operations on Country State" }, { "name": "Currency", "description": "The endpoint for operations on Currency" }, { "name": "Currency Country Rounding", "description": "The endpoint for operations on Currency Country Rounding" }, { "name": "Custom Entity", "description": "The endpoint for operations on Custom Entity" }, { "name": "Custom Field", "description": "The endpoint for operations on Custom Field" }, { "name": "Custom Field Set", "description": "The endpoint for operations on Custom Field Set" }, { "name": "Custom Field Set Relation", "description": "The endpoint for operations on Custom Field Set Relation" }, { "name": "Customer", "description": "The endpoint for operations on Customer" }, { "name": "Customer Address", "description": "The endpoint for operations on Customer Address" }, { "name": "Customer Group", "description": "The endpoint for operations on Customer Group" }, { "name": "Customer Recovery", "description": "The endpoint for operations on Customer Recovery" }, { "name": "Customer Wishlist", "description": "The endpoint for operations on Customer Wishlist" }, { "name": "Customer Wishlist Product", "description": "The endpoint for operations on Customer Wishlist Product" }, { "name": "Delivery Time", "description": "The endpoint for operations on Delivery Time" }, { "name": "Document", "description": "The endpoint for operations on Document" }, { "name": "Document Base Config", "description": "The endpoint for operations on Document Base Config" }, { "name": "Document Base Config Sales Channel", "description": "The endpoint for operations on Document Base Config Sales Channel" }, { "name": "Document File", "description": "The endpoint for operations on Document File" }, { "name": "Document Type", "description": "The endpoint for operations on Document Type" }, { "name": "Flow", "description": "The endpoint for operations on Flow" }, { "name": "Flow Sequence", "description": "The endpoint for operations on Flow Sequence" }, { "name": "Flow Template", "description": "The endpoint for operations on Flow Template" }, { "name": "Import Export File", "description": "The endpoint for operations on Import Export File" }, { "name": "Import Export Log", "description": "The endpoint for operations on Import Export Log" }, { "name": "Import Export Profile", "description": "The endpoint for operations on Import Export Profile" }, { "name": "Integration", "description": "The endpoint for operations on Integration" }, { "name": "Landing Page", "description": "The endpoint for operations on Landing Page" }, { "name": "Language", "description": "The endpoint for operations on Language" }, { "name": "Locale", "description": "The endpoint for operations on Locale" }, { "name": "Log Entry", "description": "The endpoint for operations on Log Entry" }, { "name": "Mail Header Footer", "description": "The endpoint for operations on Mail Header Footer" }, { "name": "Mail Template", "description": "The endpoint for operations on Mail Template" }, { "name": "Mail Template Type", "description": "The endpoint for operations on Mail Template Type" }, { "name": "Main Category", "description": "The endpoint for operations on Main Category" }, { "name": "Measurement Display Unit", "description": "The endpoint for operations on Measurement Display Unit" }, { "name": "Measurement System", "description": "The endpoint for operations on Measurement System" }, { "name": "Media", "description": "The endpoint for operations on Media" }, { "name": "Media Default Folder", "description": "The endpoint for operations on Media Default Folder" }, { "name": "Media Folder", "description": "The endpoint for operations on Media Folder" }, { "name": "Media Folder Configuration", "description": "The endpoint for operations on Media Folder Configuration" }, { "name": "Media Thumbnail", "description": "The endpoint for operations on Media Thumbnail" }, { "name": "Media Thumbnail Size", "description": "The endpoint for operations on Media Thumbnail Size" }, { "name": "Newsletter Recipient", "description": "The endpoint for operations on Newsletter Recipient" }, { "name": "Notification", "description": "The endpoint for operations on Notification" }, { "name": "Number Range", "description": "The endpoint for operations on Number Range" }, { "name": "Number Range Sales Channel", "description": "The endpoint for operations on Number Range Sales Channel" }, { "name": "Number Range State", "description": "The endpoint for operations on Number Range State" }, { "name": "Number Range Type", "description": "The endpoint for operations on Number Range Type" }, { "name": "Order", "description": "The endpoint for operations on Order" }, { "name": "Order Address", "description": "The endpoint for operations on Order Address" }, { "name": "Order Customer", "description": "The endpoint for operations on Order Customer" }, { "name": "Order Delivery", "description": "The endpoint for operations on Order Delivery" }, { "name": "Order Delivery Position", "description": "The endpoint for operations on Order Delivery Position" }, { "name": "Order Line Item", "description": "The endpoint for operations on Order Line Item" }, { "name": "Order Line Item Download", "description": "The endpoint for operations on Order Line Item Download" }, { "name": "Order Transaction", "description": "The endpoint for operations on Order Transaction" }, { "name": "Order Transaction Capture", "description": "The endpoint for operations on Order Transaction Capture" }, { "name": "Order Transaction Capture Refund", "description": "The endpoint for operations on Order Transaction Capture Refund" }, { "name": "Order Transaction Capture Refund Position", "description": "The endpoint for operations on Order Transaction Capture Refund Position" }, { "name": "Payment Method", "description": "The endpoint for operations on Payment Method" }, { "name": "Plugin", "description": "The endpoint for operations on Plugin" }, { "name": "Product", "description": "The endpoint for operations on Product" }, { "name": "Product Configurator Setting", "description": "The endpoint for operations on Product Configurator Setting" }, { "name": "Product Cross Selling", "description": "The endpoint for operations on Product Cross Selling" }, { "name": "Product Cross Selling Assigned Products", "description": "The endpoint for operations on Product Cross Selling Assigned Products" }, { "name": "Product Download", "description": "The endpoint for operations on Product Download" }, { "name": "Product Export", "description": "The endpoint for operations on Product Export" }, { "name": "Product Feature Set", "description": "The endpoint for operations on Product Feature Set" }, { "name": "Product Keyword Dictionary", "description": "The endpoint for operations on Product Keyword Dictionary" }, { "name": "Product Manufacturer", "description": "The endpoint for operations on Product Manufacturer" }, { "name": "Product Media", "description": "The endpoint for operations on Product Media" }, { "name": "Product Price", "description": "The endpoint for operations on Product Price" }, { "name": "Product Review", "description": "The endpoint for operations on Product Review" }, { "name": "Product Search Config", "description": "The endpoint for operations on Product Search Config" }, { "name": "Product Search Config Field", "description": "The endpoint for operations on Product Search Config Field" }, { "name": "Product Search Keyword", "description": "The endpoint for operations on Product Search Keyword" }, { "name": "Product Sorting", "description": "The endpoint for operations on Product Sorting" }, { "name": "Product Stream", "description": "The endpoint for operations on Product Stream" }, { "name": "Product Stream Filter", "description": "The endpoint for operations on Product Stream Filter" }, { "name": "Product Visibility", "description": "The endpoint for operations on Product Visibility" }, { "name": "Promotion", "description": "The endpoint for operations on Promotion" }, { "name": "Promotion Discount", "description": "The endpoint for operations on Promotion Discount" }, { "name": "Promotion Discount Prices", "description": "The endpoint for operations on Promotion Discount Prices" }, { "name": "Promotion Individual Code", "description": "The endpoint for operations on Promotion Individual Code" }, { "name": "Promotion Sales Channel", "description": "The endpoint for operations on Promotion Sales Channel" }, { "name": "Promotion Setgroup", "description": "The endpoint for operations on Promotion Setgroup" }, { "name": "Property Group", "description": "The endpoint for operations on Property Group" }, { "name": "Property Group Option", "description": "The endpoint for operations on Property Group Option" }, { "name": "Rule", "description": "The endpoint for operations on Rule" }, { "name": "Rule Condition", "description": "The endpoint for operations on Rule Condition" }, { "name": "Sales Channel", "description": "The endpoint for operations on Sales Channel" }, { "name": "Sales Channel Analytics", "description": "The endpoint for operations on Sales Channel Analytics" }, { "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, { "name": "Sales Channel Tracking Customer", "description": "The endpoint for operations on Sales Channel Tracking Customer" }, { "name": "Sales Channel Tracking Order", "description": "The endpoint for operations on Sales Channel Tracking Order" }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" }, { "name": "Salutation", "description": "The endpoint for operations on Salutation" }, { "name": "Scheduled Task", "description": "The endpoint for operations on Scheduled Task" }, { "name": "Script", "description": "The endpoint for operations on Script" }, { "name": "Seo Url", "description": "The endpoint for operations on Seo Url" }, { "name": "Seo Url Template", "description": "The endpoint for operations on Seo Url Template" }, { "name": "Shipping Method", "description": "The endpoint for operations on Shipping Method" }, { "name": "Shipping Method Price", "description": "The endpoint for operations on Shipping Method Price" }, { "name": "Snippet", "description": "The endpoint for operations on Snippet" }, { "name": "Snippet Set", "description": "The endpoint for operations on Snippet Set" }, { "name": "State Machine", "description": "The endpoint for operations on State Machine" }, { "name": "State Machine History", "description": "The endpoint for operations on State Machine History" }, { "name": "State Machine State", "description": "The endpoint for operations on State Machine State" }, { "name": "State Machine Transition", "description": "The endpoint for operations on State Machine Transition" }, { "name": "System Config", "description": "The endpoint for operations on System Config" }, { "name": "Tag", "description": "The endpoint for operations on Tag" }, { "name": "Tax", "description": "The endpoint for operations on Tax" }, { "name": "Tax Provider", "description": "The endpoint for operations on Tax Provider" }, { "name": "Tax Rule", "description": "The endpoint for operations on Tax Rule" }, { "name": "Tax Rule Type", "description": "The endpoint for operations on Tax Rule Type" }, { "name": "Theme", "description": "The endpoint for operations on Theme" }, { "name": "Unit", "description": "The endpoint for operations on Unit" }, { "name": "User", "description": "The endpoint for operations on User" }, { "name": "User Access Key", "description": "The endpoint for operations on User Access Key" }, { "name": "User Config", "description": "The endpoint for operations on User Config" }, { "name": "User Recovery", "description": "The endpoint for operations on User Recovery" }, { "name": "Webhook", "description": "The endpoint for operations on Webhook" }, { "name": "Webhook Event Log", "description": "The endpoint for operations on Webhook Event Log" } ] }